Add readme

This commit is contained in:
subnixr 2017-05-28 19:41:36 +02:00
parent 3e3d76b26f
commit 7e1e7b6a90
2 changed files with 27 additions and 2 deletions

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# Requirements
- `npm`
# Build
$ npm install
$ npm run build
Output will be in `dist/`
# Develop
$ npm install
$ gulp build
It is advised to have `gulp` installed in your system (either system or user) and exposed in `$PATH`.
To serve the content, run:
$ npm run serve
**WARNING**: this is meant only for development purposes

View File

@ -4,7 +4,8 @@
"description": "Unit fron page",
"main": "src/index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"build": "gulp build",
"serve": "http-server dist/"
},
"repository": {
"type": "git",
@ -18,8 +19,9 @@
"gulp-clean": "^0.3.2",
"gulp-less": "^3.3.0",
"gulp-newer": "^1.3.0",
"http-server": "^0.10.0",
"vinyl-source-stream": "^1.1.0",
"vinyl-transform": "^1.0.0",
"watchify": "^3.9.0"
}
}
}