diff --git a/README.md b/README.md index 02f393f..5572b3d 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,12 @@ The motivation for this CLI is to make it simple to get started when creating a | `rackt pages` | Deploys the examples to gh-pages. | -### `init` +#### `init` The `init` command generates a component structure based on the opinions of this CLI. It provides a basic working component, along with a simple example, and a failing test. -### `build` +#### `build` The `build` command uses [webpack](http://webpack.github.io/), along with [babel](https://babeljs.io/) to transpile your code. This means you are free to use JSX, and ES6 in your source, as it will be transpiled before shipping. @@ -39,22 +39,22 @@ This command will generate two new folders within your component's folder. A `dist/` folder contains a UMD version of your project, which is ideal for releasing to bower. A `build/` folder will contain a transpiled version of your original source, un-bundled, for releasing to npm. -### `server` +#### `server` The `server` command uses [webpack-dev-server](http://webpack.github.io/docs/webpack-dev-server.html) to serve your examples in the browser. You may also run `npm start` as an alias to this command. -### `release` +#### `release` The `release` command runs `test`, and `build` command, then updates your CHANGELOG, creates a new tag, and releases to npm. -### `test` +#### `test` The `test` command runs [karma](http://karma-runner.github.io/), using [mocha](http://mochajs.org/). It will look for files under `lib/` suffixed with `-test.js`. You can put these files alongside your source, or under sub-folders like `__tests__/`. -### `pages` +#### `pages` The `pages` command will deploy your examples to a `gh-pages` branch.