Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch from a monorepo to a single package #125

Merged
merged 22 commits into from
Feb 6, 2018
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
README: reorder script docs
  • Loading branch information
Rowno committed Feb 5, 2018
commit 2db265801b6e016497804d29ba2f594ea080ad2c
33 changes: 14 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,21 @@ Below you can read a description of each script.

Starts the development React Storybook.

### `yarn storybook-to-ghpages`
### `yarn test`

Lints the JavaScript files using XO and then runs the unit tests using AVA.

### `yarn build`

Builds all of the JavaScript files using Babel.

Build a static version of the storybook and deploys it onto the `gh-pages`
(GitHub pages) branch. This will make it available on [https://segmentio.github.io/evergreen](https://segmentio.github.io/evergreen).
### `yarn clean`

Removes all untracked files (`git clean -Xdf`).

### `yarn release`

Releases new version of Evergreen, using `np` to prepare it and CircleCI to publish it.

### `yarn create-package`

Expand Down Expand Up @@ -121,22 +132,6 @@ The following file tree will be generated:
└── index.js
```

### `yarn test`

Lints the JavaScript files using XO and then runs the unit tests using AVA.

### `yarn build`

Builds all of the JavaScript files using Babel.

### `yarn clean`

Removes all untracked files (`git clean -Xdf`).

### `yarn release`

Releases new version of Evergreen, using `np` to prepare it and CircleCI to publish it.

## Contributors 🎉

We will add you to the list if you make any contribution!
Expand Down