From 269c89be29d6556f09092b1b416c31077b3341ad Mon Sep 17 00:00:00 2001 From: Nicolas Dextraze Date: Mon, 7 Nov 2016 22:09:57 -0800 Subject: [PATCH] Add Documentation section to README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 6d950ae..c26737a 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,16 @@ Unstable - Performance: there's still some while loop in the code that could be problematic with node.js - Tests: tests are only covering happy path scenarios for now +### Documentation + +#### Offline + +The offline documentation can be found in the module folder `./node_modules/eventstore-node/docs`. + +#### Online + +The online documentation can be found at [https://dev.nicdex.com/eventstore-node/docs/](https://dev.nicdex.com/eventstore-node/docs/) + ## Getting started ### Install & run Eventstore on localhost