Skip to content

Commit

Permalink
[chore] added documentation for development.
Browse files Browse the repository at this point in the history
  • Loading branch information
diasbruno committed Jun 19, 2017
1 parent aaeb310 commit 8d87599
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Summary

* [Read Me](/README.md)

* [Development](dev/README.md)

* [Styles](styles/README.md)
* [Using CSS Classes](styles/classes.md)
* [Overriding Defaults](styles/defaults.md)
Expand Down
33 changes: 33 additions & 0 deletions docs/dev/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Development

`react-modal` uses `make` to build and publish new versions and documentation.

It works as a checklist for the future releases to keep everything updated such as
`CHANGELOG.md`, `package.json` and `bower.json` and so on.

The minimun works as a normal `npm script`.

## Usage

Once you clone `react-modal`, you can run `sh bootstrap.sh` to check
and download dependencies not managed by `react-modal` such as `gitbook-cli`.

It will also show information about the current versions of `node`, `npm`,
`yarn` and `jq` available.

## List of `npm` commands:

$ npm start -s or yarn start # to run examples
$ npm run tests
$ npm run lint

## List of `make` commands:

$ make help # show all make commands available
$ make deps # npm install, gitbook plugins...
$ make serve # to run examples
$ make tests # use when developing
$ make tests-ci # single run
$ make lint # pass lint
$ make publish # execute the entire pipeline to publish
$ make publish-docs # execute the pipeline for docs

0 comments on commit 8d87599

Please sign in to comment.