added way of running the docs locally

xola · Feb 3, 2020 · 23393f6 · 23393f6
1 parent 08950b2
commit 23393f6
Show file tree

Hide file tree

Showing 3 changed files with 203 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # Independent Connectivity Forum
 
-This project includes an independently-developed API specification for facilitating communcation between partners, SLA guidelines, as well as templates and validation tools for implementing the API.
+This project includes an independently-developed API specification for facilitating communication between partners, SLA guidelines, as well as templates and validation tools for implementing the API.
+
+To run the documentation locally, clone the repository and run `npm start`.
 
 ## API Structure
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -0,0 +1,8 @@
+{
+  "dependencies": {
+    "http-server": "^0.12.1"
+  },
+  "scripts": {
+    "start": "http-server ./docs -o"
+  }
+}