diff --git a/README.md b/README.md index 7ce76b9d9..38e3d9420 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,10 @@ Create authentic looking D&D homebrews using only markdown. Check it out [here]( 1. Make sure you have [node](https://nodejs.org/en/) 1. Clone down the repo 1. In your terminal, head to the repo -1. Run `npm install` to get all the dependacies -2. Run `npm install -g gulp` to install the gulp build tool -1. Run `gulp fresh`, this will compile and build all the needed libraries (this only has to be done once, unless you add more libs) -1. Run `gulp` to run the project locally. Should be accessible at `localhost:8000` -2. Any changes to files within the proejct will be detected and the propject will automatically re-build +1. Run `npm install` to get all the dependencies +1. Run `npm run libs`, this will compile and build all the needed libraries (this only has to be done once, unless you add more libs) +1. Run `npm run watch` to run the project locally. Should be accessible at `localhost:8000` +2. Any changes to files within the project will be detected and the project will automatically re-build **Notes:** If you'd like to create and edit homebrews, you'll need to have MongoDB installed and running. @@ -28,10 +27,10 @@ You can use [Docker](https://docs.docker.com) to get up and running with Natural 1. You may have to use `docker-machine env` to get the IP address of your docker instance -### changelog +### Changelog You can check out the changelog [here](https://github.com/stolksdorf/homebrewery/blob/master/changelog.md) -### license +### License -This project licensed under [MIT](./license) \ No newline at end of file +This project is licensed under [MIT](./license) diff --git a/package.json b/package.json index b00abd3d2..ce2c4821d 100644 --- a/package.json +++ b/package.json @@ -3,11 +3,14 @@ "description": "Create authentic looking D&D homebrews using only markdown", "version": "2.3.0", "scripts": { - "postinstall": "gulp prod", + "build": "node_modules/.bin/gulp prod", + "watch": "node_modules/.bin/gulp", + "libs": "node_modules/.bin/gulp fresh", + "postinstall": "npm run build", "start": "node server.js" }, "author": "stolksdorf", - "license": "BSD-2-Clause", + "license": "MIT", "dependencies": { "app-module-path": "^1.0.4", "basic-auth": "^1.0.3",