Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update README.md #1

Merged
merged 1 commit into from
Jul 10, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Gluttony

Compliant elixir RSS 2.0 and Atom 1.0 parser.
Compliant elixir RSS 2.0 and Atom 1.0 parser.
Ingests and parses RSS feeds and returns raw data that can be enriched by unfurling URLs.

## Installation

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

```elixir
def deps do
Expand All @@ -15,10 +14,9 @@ def deps do
]
end
```
## Documentation

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/gluttony>.
Documentation can be found at <https://hexdocs.pm/gluttony>.

## Benchmarks

Expand Down