Skip to content
This repository has been archived by the owner on Feb 25, 2020. It is now read-only.

add npm README.md #38

Closed
wants to merge 1 commit into from
Closed

add npm README.md #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

<pre>
__ __ __ __ __ ____
/ /_/ /_ ___ / /___ _________ _/ / _____/ /___ __ ______/ / /
/ __/ __ \/ _ \ / / __ \/ ___/ __ `/ / / ___/ / __ \/ / / / __ / /
/ /_/ / / / __/ / / /_/ / /__/ /_/ / / / /__/ / /_/ / /_/ / /_/ /_/
\__/_/ /_/\___/ /_/\____/\___/\__,_/_/ \___/_/\____/\__,_/\__,_(_)
</pre>


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