Merge pull request #202 from hannu/use-readme-overview

Use Github readme as a demo project overview page

Author: Juuso Backman

README.md

@@ -279,12 +279,11 @@ When sassVariables is defined and styleguide is served with the built-in server,
 
 ## Demo
 
-Build demo styleguide and start a server
+Build demo styleguide and start a server on port 3000
 
-    gulp demo
+    npm run demo
 
-Note: If you installed styleguide by cloning repository directly instead of npm you need to run `gulp build` first
-You can change the default port (3000) with `--port`;
+Note: If you installed styleguide by cloning repository directly instead of npm you need to run `npm run build` first
 
 The demo generates styleguide to `demo-output` directory.
 

lib/app/overview.md

@@ -1,6 +1,6 @@
 {
   "title": "SC5 Styleguide",
-  "overviewPath": "overview.md",
+  "overviewPath": "../../README.md",
   "styleVariables": "sass/_styleguide_variables.scss",
   "sass": {
     "src": "lib/app/sass/app.scss",

lib/app/styleguide_config.json

@@ -88,6 +88,8 @@
   "scripts": {
     "test": "node_modules/istanbul/lib/cli.js cover --config=test/istanbul.conf.json --dir=coverage/mocha node_modules/mocha/bin/_mocha && node_modules/karma/bin/karma start test/karma.conf.js && node_modules/gulp/bin/gulp.js jscs",
     "coverage-report": "node_modules/istanbul/lib/cli.js report --root ./coverage --dir ./coverage/report lcov",
-    "prepublish": "node_modules/gulp/bin/gulp.js build"
+    "prepublish": "node_modules/gulp/bin/gulp.js build",
+    "build": "node_modules/gulp/bin/gulp.js build",
+    "demo": "node_modules/gulp/bin/gulp.js demo"
   }
 }