Skip to content

Commit

Permalink
add butler commands and update readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
palantir-team committed Mar 27, 2016
1 parent 2123a5d commit 79b94a8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]".

Expand Down
11 changes: 8 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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",
Expand Down

0 comments on commit 79b94a8

Please sign in to comment.