Install insctuctions

sourcejs · Jan 4, 2015 · 2fc957e · 2fc957e
1 parent 2b2d912
commit 2fc957e
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+# IDE
+.idea
+*.iml
+
 # Logs
 logs
 *.log

diff --git a/README.md b/README.md
@@ -1,4 +1,31 @@
-sourcejs-jade
-=============
+Jase support for SourceJS
+===============
 
-Jade support for NodeJS
+[SourceJS](http://sourcejs.com) middleware to support [Jade](http://jade-lang.com/) markup language (`*.jade`) instead of native `*.src`.
+
+## Install
+
+To install, run npm in `sourcejs/user` folder:
+
+```
+npm install sourcejs-jade --save
+```
+
+Then restart your SourceJS application, middleware will be loaded automatically.
+
+## Usage
+
+After installing middleware, instead of `index.src` pages, you can `index.jade` files with Jade markup.
+
+index.jade
+
+```
+h1 Jade - node template engine
+
+#container.col
+    p.
+        Jade is a terse and simple
+        templating language with a
+        strong focus on performance
+        and powerful features.
+```
diff --git a/core/middleware/sourcejs-jade/index.js → core/middleware/index.js b/core/middleware/sourcejs-jade/index.js → core/middleware/index.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sourcejs-jade",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Jade support for SourceJS",
   "main": "index.js",
   "dependencies": {
-Original file line number
+Diff line change
@@ -1,3 +1,7 @@
+    # IDE
+    .idea
+    *.iml
     # Logs
     logs
     *.log
@@ Expand Down @@