Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update readme with how to get running

  • Loading branch information...
commit 9c0f2a03a7ae1f8e57b522f96e0727f4aa3a4c9d 1 parent 5ab0ed8
@zacheryph zacheryph authored
Showing with 12 additions and 2 deletions.
  1. +12 −2 README.md
View
14 README.md
@@ -1,11 +1,21 @@
Medusa JS
================================
-Medusa JS is a static website generator written in javascript and designed for use with node.js.
+Medusa JS is a static website generator written in node.js
-Medusa will allow you to generate the static directly on the server or generate the html files locally for upload to your server
+Medusa will allow you to generate the static directly on the server
+or generate the html files locally for upload to your server
Medusa is in early development and is not ready for use anywhere. Please stay tuned.
+To Get Running
+-------------------------
+* Install packages using npm >= 1.0
+ npm install
+* Run setup script
+ node bin/setup.js
+* Run the server
+ node bin/server.js
+
Dependencies
-------------------------
* express
Please sign in to comment.
Something went wrong with that request. Please try again.