diff --git a/README.md b/README.md index 2f2a2f5..8cfce9d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Butler -The beginnings of a Sculpin based style guide creation tool. +The beginnings of a Sculpin-based style guide creation tool. ## Dependencies 1. NodeJS @@ -11,28 +11,24 @@ The beginnings of a Sculpin based style guide creation tool. 1. Add Butler as a dependency by running `npm install --save git://github.com/palantirnet/butler.git#remove-ruby` ## Getting Started with Butler -1. From inside the Butler root, run `npm install -g gulp` +1. From inside the Butler root, run `npm install` - This will install Gulp globally. + This will install all of the npm dependencies for Butler. _some commands may require being run as `sudo`_ -1. run `npm install` - - This will install all of the npm dependencies for Butler. - -1. Run `gulp` or `gulp develop` and begin developing normally +1. Run `npm run butler` and begin developing normally ## What does this Butler do -* `gulp develop`/`gulp` +* `npm run butler` This is the default task. This will watch your sass/sculpin files for changes and compile/build accordingly. It will also flag any sass linting errors before compiling. It will output CSS that has been been minified and optimized. -* `gulp test` +* `npm run linting` This is the testing task it will run linters as their own tasks. To learn more about configuring and customizing the linters for Butler check the [linters documentation](/docs/LINTERS.md). -* `gulp deploy` +* `npm run deploy` This is a task to deploy the static styleguide to GitHub pages. It will deploy to `gh-pages` branch of the repo defined in the `config/paths.js`. Each commit for this process will default to the message: "Updated with Butler - [timestamp]". diff --git a/package.json b/package.json index 452527a..69a689f 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,12 @@ { - "name": "butler", - "version": "1.0.0", + "name": "@palantirnet/butler", + "version": "2.0.0", "description": "This is a stater-kit for Palantir.net style guide", "main": "Gulpfile.js", "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" + "butler": "gulp develop", + "linting": "gulp test", + "deploy": "gulp deploy" }, "repository": { "type": "git", @@ -15,6 +17,9 @@ "bugs": { "url": "https://github.com/palantirnet/butler/issues" }, + "bin": { + "butler": "./bin/butler" + }, "homepage": "https://github.com/palantirnet/butler#readme", "dependencies": { "autoprefixer": "^6.3.3",