From a092474a03a802a72ac1c575598f7453bc9ff7e6 Mon Sep 17 00:00:00 2001 From: Kenneth Lim Date: Sat, 21 Feb 2015 22:43:57 +0800 Subject: [PATCH] add npm README.md Fixes: https://github.com/spark/spark-server/issues/37 --- js/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 js/README.md diff --git a/js/README.md b/js/README.md new file mode 100644 index 00000000..db7dce97 --- /dev/null +++ b/js/README.md @@ -0,0 +1,25 @@ +spark-server +============ + +An API compatible open source server for interacting with devices speaking the [spark-protocol](https://github.com/spark/spark-protocol) + +
+   __  __            __                 __        __                ____
+  / /_/ /_  ___     / /___  _________ _/ /  _____/ /___  __  ______/ / /
+ / __/ __ \/ _ \   / / __ \/ ___/ __ `/ /  / ___/ / __ \/ / / / __  / / 
+/ /_/ / / /  __/  / / /_/ / /__/ /_/ / /  / /__/ / /_/ / /_/ / /_/ /_/  
+\__/_/ /_/\___/  /_/\____/\___/\__,_/_/   \___/_/\____/\__,_/\__,_(_)   
+
+ + +Quick Install +============== + +``` +git clone https://github.com/spark/spark-server.git +cd spark-server/js +npm install +node main.js +``` + +The full documentation is available at: https://github.com/spark/spark-server