slight changes to README

README.md

@@ -101,12 +101,12 @@ The library source code is minimal and tested. It is highly suggested that you c
 
   ```elixir
     def deps do
-      [{:paper_trail, "~> 0.0.1"}]
+      [{:paper_trail, "~> 0.5.0"}]
     end
   ```
 
-  2. configure the repo module to use
-  
+  2. configure paper_trail to use your application repo in `config/config.exs`:
+
   ```elixir
   config :paper_trail, repo: YourApplicationName.Repo
   ```
@@ -125,9 +125,9 @@ The library source code is minimal and tested. It is highly suggested that you c
 
 Your application is now ready to collect some history!
 
-## How to use paper_trail with phoenix?
+## Does this work with phoenix?
 
-A guide needs to be written for this. Although it isn't that hard to implement for the brave.
+YES! Make sure you do the steps.
 
 TODO AREA:
 
@@ -137,11 +137,9 @@ TODO AREA:
 
 ## Storing version meta data
 
-give originator example
-
 Your versions don't need a model lifecycle callbacks like before_create or before_update for any extra meta data, all your meta data could be stored in one object and that object could be passed as the second optional parameter to PaperTrail.insert || PaperTrail.update || PaperTrail.delete
 
 ## Suggestions
 
 - PaperTrail.Version(s) order matter,
-- don't delete your versions merge them
+- don't delete your paper_trail versions, instead you can merge them

doc/.build

@@ -0,0 +1,16 @@
+dist/app-4aef34ad5f.js
+dist/app-a07cea761b.css
+fonts/icomoon.eot
+fonts/icomoon.svg
+fonts/icomoon.ttf
+fonts/icomoon.woff
+dist/sidebar_items-4905f94f69.js
+api-reference.html
+index.html
+404.html
+Mix.Tasks.Papertrail.Install.html
+PaperTrail.html
+PaperTrail.Migration.html
+PaperTrail.RepoClient.html
+PaperTrail.Version.html
+PaperTrail.VersionQueries.html

mix.exs

@@ -3,7 +3,7 @@ defmodule PaperTrail.Mixfile do
 
   def project do
     [app: :paper_trail,
-     version: "0.1.6",
+     version: "0.5.0",
      elixir: "~> 1.3",
      description: description,
      build_embedded: Mix.env == :prod,