Improve documentation for hex.pm

The README.md file was improved to be used as the main page of the
documentaion on hex.pm

The TODOs containg possible features have been moved to github issues.

Closes #4

Author: caioceccon

README.md

@@ -2,31 +2,53 @@
 
 **A module to generate a random string based on a given string pattern**
 
+## Installation
+
+The package can be installed by adding `random_string_generator` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:random_string_generator, "~> 0.1.1"}
+  ]
+end
+```
+
+## Usage
+
 #### Accepted string patterns:
 
   Use `l` for lower case letter from a to z
-  
+
   Use `L` for upper case letter from A to Z
-  
+
   Use `d` for digit from 0 to 9
-  
+
   Use `p` for punctuation
 
 #### Punctuation is any character on the following group:
 
-    @punctuation [
-        "!", "\"", "#", "$", "%", "&", "'", "(", ")", "*", "+", ",", "-",
-        ".", "/", ":", ";", "<", "=", ">", "?", "@", "[", "\\", "]", "^",
-        "_", "`", "{", "|","}", "~"
-    ]
+  `!`, `"`, `#`, `$`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `-`,
+  `.`, `/`, `:`, `;`, `<`, `=`, `>`, `?`, `@`, `[`, ` \ `, `]`, `^`,
+  `_`, `{`, `|`,`}`, `~` and `` ` ``
 
 ##### Generate a string containing 2 lower case letters followed by 2 digits.
-      
-    RandomStringGenerator.generate("lldd")
+```elixir
+iex> RandomStringGenerator.generate("lldd")
+"ol68"
+```
 
 ##### Generate a string containing 2 upper case letters.
-      
-    RandomStringGenerator.generate("LL")
+```elixir
+iex> RandomStringGenerator.generate("LL")
+"VR"
+```
+
+##### Generate a string containing 2 punctuations.
+```elixir
+iex> RandomStringGenerator.generate("pp")
+"?!"
+```
 
 **Delimiters**
 
@@ -35,28 +57,20 @@
   a lower case letter followed by a question mark.
 
 ##### Generate a string containing 2 letters followed by a hyphen.
-    
-    RandomStringGenerator.generate("ll-")
+```elixir
+iex> RandomStringGenerator.generate("ll-")
+"yz-"
+```
 
 **Scape**
 
   In order to generate a string containing the characters `l`,`L`,`d` and `p`
   as a delimiter you need to use the backslash twice in order to scape it.
 
 ##### Generate a string containing 2 digits followed by the letters `lLdp`.
-    
-    RandomStringGenerator.generate("dd\\l\\L\\d\\p")
-
-## Installation
-
-The package can be installed by adding `random_string_generator` to your list of dependencies in `mix.exs`:
-
 ```elixir
-def deps do
-  [
-    {:random_string_generator, "~> 0.1.0"}
-  ]
-end
+iex> RandomStringGenerator.generate("dd\\l\\L\\d\\p")
+"39lLdp"
 ```
 
 Full documentation at [https://hexdocs.pm/random_string_generator](https://hexdocs.pm/random_string_generator).

lib/random_string_generator.ex

@@ -50,9 +50,6 @@ defmodule RandomStringGenerator do
     "}", "~"
   ]
 
-  # TODO accept list of chars to be used as special case
-  # TODO implement pattern repetition like d{1}
-
   @doc """
   Given a `pattern` string, returns a random generated string.
 

mix.exs

@@ -1,16 +1,17 @@
 defmodule RandomStringGenerator.Mixfile do
   use Mix.Project
+  @version "0.1.1"
 
   def project do
     [
       app: :random_string_generator,
-      version: "0.1.0",
+      version: @version,
       elixir: "~> 1.5",
       start_permanent: Mix.env == :prod,
       deps: deps(),
       description: description(),
       package: package(),
-      source_url: "https://github.com/caioceccon/random_string_generator/",
+      docs: docs()
     ]
   end
 
@@ -44,4 +45,13 @@ defmodule RandomStringGenerator.Mixfile do
       links: %{"GitHub" => "https://github.com/caioceccon/random_string_generator"}
     ]
   end
+
+  defp docs do
+    [
+      source_ref: "v#{@version}",
+      extras: ["README.md"],
+      main: "readme",
+      source_url: "https://github.com/caioceccon/random_string_generator/",
+    ]
+  end
 end