Skip to content
This repository has been archived by the owner on Aug 5, 2021. It is now read-only.

Commit

Permalink
Merge pull request #8 from patrickgordon/master
Browse files Browse the repository at this point in the history
Add changelog, version bump, fix readme
  • Loading branch information
patrickgordon authored Jan 31, 2019
2 parents d500aaf + 568d85a commit fa32f09
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 6 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [2.0.0] - 2019-02-01
### Changed
- Callback param can be optional [@ntnbrtnkv](https://github.com/ntnbrtnkv)
### Added
- Support for emotion v10 [@teddybradford](https://github.com/teddybradford)

## [1.1.0] - 2018-12-12
### Added
- Add callback for themes provider [@patrickgordon](https://github.com/patrickgordon)

## [1.0.0] - 2018-12-06
- Initial release based on library from [@echoulen](https://github.com/echoulen)
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
#### Please note:
Currently only tested with emotion v9.

#### Installation
```bash
yarn add storybook-addon-emotion-theme --dev
Expand All @@ -9,7 +6,7 @@ yarn add storybook-addon-emotion-theme --dev
#### Add to .storybook/addons.js

```javascript
import 'storybook-addon-emotion-theme/dist/src/register';
import 'storybook-addon-emotion-theme/dist/register';
```

#### addDecorator to .storybook/config.js
Expand All @@ -36,7 +33,16 @@ storiesOf("demo", module)
```

#### Reminder
Make sure every theme has a `name` property
Make sure every theme has a `name` property. For example:

```
const myTheme = {
name: "Light",
primaryColor: "blue"
}
```

This is used for displaying in the Storybook UI.


#### Contributing
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "storybook-addon-emotion-theme",
"version": "1.1.0",
"version": "2.0.0",
"description": "storybook addon with emotion theme",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit fa32f09

Please sign in to comment.