Add a bit of README and prep for doc generation

skovsgaard · Aug 21, 2016 · 04c7f02 · 04c7f02
1 parent 50e1203
commit 04c7f02
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,12 @@
 # RssSync
 
-**TODO: Add description**
+This is an OTP application which retrieves, parses, and stores RSS feeds, and when prompted to, keeps them in sync with their RSS feed sources.
+
+Its API isn't finalized but it's usable as is and currently allows for adding, removing, synchronizing, and persisting feeds to disk.
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
+[Available on Hex](https://hex.pm/docs/publish), the package can be installed as:
 
   1. Add `rss_sync` to your list of dependencies in `mix.exs`:
 

diff --git a/mix.exs b/mix.exs
@@ -29,6 +29,7 @@ defmodule RssSync.Mixfile do
   # Type "mix help deps" for more examples and options
   defp deps do
     [{:feeder, git: "/~https://github.com/michaelnisi/feeder"},
-     {:httpoison, "~> 0.9"}]
+     {:httpoison, "~> 0.9"},
+     {:ex_doc, "~> 0.13", only: :dev}]
   end
 end