diff --git a/README.md b/README.md new file mode 100644 index 0000000..3c4168f --- /dev/null +++ b/README.md @@ -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 \ No newline at end of file diff --git a/package.json b/package.json index b946c46..8862547 100644 --- a/package.json +++ b/package.json @@ -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" } -} +} \ No newline at end of file