Adding docs to readme.

Signed-off-by: Euan Torano <[email protected]>
euantorano · Jun 16, 2017 · 654c673 · 654c673
1 parent b2fc2c3
commit 654c673
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -18,6 +18,8 @@ Or add the following to your `.nimble` file:
 requires "pledge >= 1.1.0"
 ```
 
+## [Documentation](https://htmlpreview.github.io/?https://github.com/euantorano/pledge.nim/blob/master/docs/pledge.html)
+
 ## Usage
 
 ```nim

diff --git a/tests/main.nim b/tests/main.nim
@@ -11,4 +11,4 @@ suite "pledge tests":
       pledge(Promise.Stdio)
 
       expect OSError:
-        pledge(Promise.Stdio, Promise.Rpath) == false
+        pledge(Promise.Stdio, Promise.Rpath)
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,6 +18,8 @@ Or add the following to your `.nimble` file: @@
     requires "pledge >= 1.1.0"
     ```
+    ## [Documentation](https://htmlpreview.github.io/?https://github.com/euantorano/pledge.nim/blob/master/docs/pledge.html)
     ## Usage
     ```nim
@@ Expand Down @@