Skip to content

Commit

Permalink
Fix CI rewrite fishjam_protos README
Browse files Browse the repository at this point in the history
  • Loading branch information
Karolk99 committed Nov 7, 2024
1 parent 97409c1 commit 5a8eed2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,16 @@ jobs:
elixir-version: ${{matrix.elixir}}
- name: Checkout the code
uses: actions/checkout@v3
with:
path: fishjam_protos
- name: Install dependencies
run: mix deps.get
working-directory: fishjam_protos
- name: Compile without warnings
id: compile
run: mix compile --warnings-as-errors
working-directory: fishjam_protos
- name: Check formatting
if: ${{ !cancelled() && steps.compile.outcome == 'success' }}
run: mix format --check-formatted
working-directory: fishjam_protos
9 changes: 2 additions & 7 deletions fishjam_protos/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# FishjamProtos

**TODO: Add description**
Elixir protobuf modules for Fishjam and [MembraneRTCEngine](https://github.com/fishjam-cloud/membrane_rtc_engine)

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `fishjam_protos` to your list of dependencies in `mix.exs`:
The package can be installed by adding `fishjam_protos` to your list of dependencies in `mix.exs`:

```elixir
def deps do
Expand All @@ -15,7 +14,3 @@ def deps do
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/fishjam_protos>.

0 comments on commit 5a8eed2

Please sign in to comment.