Skip to content

Commit

Permalink
Document yarn release, add .yarnrc & .eslintignore (#5)
Browse files Browse the repository at this point in the history
Document yarn release, add .yarnrc & .eslintignore
  • Loading branch information
shilman authored Jun 3, 2019
2 parents 6dc8492 + 5ece435 commit 718eee5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
dist/**/*.js
storybook-static/**/*.js
1 change: 1 addition & 0 deletions .yarnrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
registry "https://registry.npmjs.org/"
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ npm install --save @storybook/design-system
## Usage

```jsx
import React, { Component } from "react";
import React, { Component } from 'react';

import MyComponent from "@storybook/design-system";
import MyComponent from '@storybook/design-system';

class Example extends Component {
render() {
Expand All @@ -24,6 +24,21 @@ class Example extends Component {
}
```

## Development Scripts

#### `yarn release`

> Bump the version
> Push a release to GitHub and npm
> Push a changelog to GitHub
_Notes:_

- Requires authentication with [`npm adduser`](https://docs.npmjs.com/cli/adduser.html)
- [`auto`](https://github.com/intuit/auto) is used to generate a changelog and push it to GitHub. In order for this to work correctly, **an environment variable called `GH_TOKEN` is needed** that references a [GitHub personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) with the appropriate permissions to update the repo.

## License

MIT © [shilman](https://github.com/shilman)

0 comments on commit 718eee5

Please sign in to comment.