From 2bedbea8a75fb4cac845a9cda7fc76db97b5bd5d Mon Sep 17 00:00:00 2001 From: Tim Stallard Date: Mon, 13 Mar 2017 11:15:57 +0000 Subject: [PATCH] Create README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..961ff46 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +To build this project, you'll need to have Node.JS and NPM installed. + +You can then download the project using Git, and install the dependencies: + +1. `git clone https://github.com/TimStallard/CryptoAssist.git` +2. `npm install` + +If you'd like to run webpack's development server, run `npm run build-server`. This will start a web server listening on port 8080 with live reload and automatic recompilation when files are edited. +Babel isn't used for the development version, so you'll need to use a browser with full ES6 support. + +To generate a minified ES5 version of the project for distribution, run `npm run build`. This will use Babel and Uglify to convert the project to ES5 and minify it. The output will be placed in the `build` directory.