diff --git a/README.md b/README.md index 378b891..c48412c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 . +Documentation can be found at . ## Benchmarks