Update md doc [ci skip]

- Fix typo in README - Fix branch links
tank-bohr · Nov 21, 2018 · 8c73b63 · 8c73b63
1 parent ee4a1a3
commit 8c73b63
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 Copyright (c) 2018 Alexey Nikitin
 
-__Version:__ 0.2.5
+__Version:__ 0.2.6
 
 __Authors:__ Alexey Nikitin ([`tank@bohr.su`](mailto:tank@bohr.su)) (_web site:_ [`https://twitter.com/tank_bohr`](https://twitter.com/tank_bohr)).
 
@@ -50,7 +50,7 @@ First step: add to your rebar config
 {profiles, [
     {test, [
         {deps, [
-            {bookish_spork, "0.2.5"}
+            {bookish_spork, "0.2.6"}
         ]}
     ]}
 ]}.
@@ -94,19 +94,19 @@ As usual the main goal is to test that you send the correct request
 
 ```erlang
 
-{ok, equest} = bookish_spork:capture_request().
+{ok, Request} = bookish_spork:capture_request().
 
 ```
 
 It returns you an opaque structure of the request. You can inspect it with
 
-- [`bookish_spork_request:method/1`](http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_request.md#method-1)
+- [`bookish_spork_request:method/1`](http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_request.md#method-1)
 
-- [`bookish_spork_request:uri/1`](http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_request.md#uri-1)
+- [`bookish_spork_request:uri/1`](http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_request.md#uri-1)
 
-- [`bookish_spork_request:headers/1`](http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_request.md#headers-1)
+- [`bookish_spork_request:headers/1`](http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_request.md#headers-1)
 
-- [`bookish_spork_request:body/1`](http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_request.md#body-1)
+- [`bookish_spork_request:body/1`](http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_request.md#body-1)
 
 
 #### <a name="Bypass_comparision">Bypass comparision</a> ####
@@ -189,9 +189,9 @@ end
 
 ```
 
-[Module to work with request](http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_request.md)
+[Module to work with request](http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_request.md)
 
-[Module to work with response](http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_response.md)
+[Module to work with response](http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_response.md)
 
 <h5><a name="Elixir_example">Elixir example</a></h5>
 
@@ -225,9 +225,9 @@ For more details see examples dir.
 
 
 <table width="100%" border="0" summary="list of modules">
-<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork.md" class="module">bookish_spork</a></td></tr>
-<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_format.md" class="module">bookish_spork_format</a></td></tr>
-<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_request.md" class="module">bookish_spork_request</a></td></tr>
-<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_response.md" class="module">bookish_spork_response</a></td></tr>
-<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/data-driven/doc/bookish_spork_server.md" class="module">bookish_spork_server</a></td></tr></table>
+<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork.md" class="module">bookish_spork</a></td></tr>
+<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_format.md" class="module">bookish_spork_format</a></td></tr>
+<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_request.md" class="module">bookish_spork_request</a></td></tr>
+<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_response.md" class="module">bookish_spork_response</a></td></tr>
+<tr><td><a href="http://github.com/tank-bohr/bookish_spork/blob/master/doc/bookish_spork_server.md" class="module">bookish_spork_server</a></td></tr></table>
 
diff --git a/doc/README.md b/doc/README.md
@@ -4,7 +4,7 @@
 
 Copyright (c) 2018 Alexey Nikitin
 
-__Version:__ 0.2.5
+__Version:__ 0.2.6
 
 __Authors:__ Alexey Nikitin ([`tank@bohr.su`](mailto:tank@bohr.su)) (_web site:_ [`https://twitter.com/tank_bohr`](https://twitter.com/tank_bohr)).
 
@@ -50,7 +50,7 @@ First step: add to your rebar config
 {profiles, [
     {test, [
         {deps, [
-            {bookish_spork, "0.2.5"}
+            {bookish_spork, "0.2.6"}
         ]}
     ]}
 ]}.
@@ -94,7 +94,7 @@ As usual the main goal is to test that you send the correct request
 
 ```erlang
 
-{ok, equest} = bookish_spork:capture_request().
+{ok, Request} = bookish_spork:capture_request().
 
 ```
 

diff --git a/doc/overview.edoc b/doc/overview.edoc
@@ -96,7 +96,7 @@ As usual the main goal is to test that you send the correct request
 
 
 <pre lang="erlang">
-{ok, equest} = bookish_spork:capture_request().
+{ok, Request} = bookish_spork:capture_request().
 </pre>
 
 It returns you an opaque structure of the request. You can inspect it with

diff --git a/rebar.config b/rebar.config
@@ -19,7 +19,8 @@
         ]},
         {edoc_opts, [
             {doclet, edown_doclet},
-            {top_level_readme, {"./README.md", "http://github.com/tank-bohr/bookish_spork"}}
+            {top_level_readme,
+                {"./README.md", "http://github.com/tank-bohr/bookish_spork", "master"}}
         ]}
     ]}
 ]}.