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

Commit 568d85a

Browse files
committed
Add changelog, version bump, fix readme
Resolves #2
1 parent d500aaf commit 568d85a

File tree

3 files changed

+29
-6
lines changed

3 files changed

+29
-6
lines changed

CHANGELOG.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
5+
6+
## [2.0.0] - 2019-02-01
7+
### Changed
8+
- Callback param can be optional [@ntnbrtnkv](https://github.com/ntnbrtnkv)
9+
### Added
10+
- Support for emotion v10 [@teddybradford](https://github.com/teddybradford)
11+
12+
## [1.1.0] - 2018-12-12
13+
### Added
14+
- Add callback for themes provider [@patrickgordon](https://github.com/patrickgordon)
15+
16+
## [1.0.0] - 2018-12-06
17+
- Initial release based on library from [@echoulen](https://github.com/echoulen)

README.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
#### Please note:
2-
Currently only tested with emotion v9.
3-
41
#### Installation
52
```bash
63
yarn add storybook-addon-emotion-theme --dev
@@ -9,7 +6,7 @@ yarn add storybook-addon-emotion-theme --dev
96
#### Add to .storybook/addons.js
107

118
```javascript
12-
import 'storybook-addon-emotion-theme/dist/src/register';
9+
import 'storybook-addon-emotion-theme/dist/register';
1310
```
1411

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

3835
#### Reminder
39-
Make sure every theme has a `name` property
36+
Make sure every theme has a `name` property. For example:
37+
38+
```
39+
const myTheme = {
40+
name: "Light",
41+
primaryColor: "blue"
42+
}
43+
```
44+
45+
This is used for displaying in the Storybook UI.
4046

4147

4248
#### Contributing

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "storybook-addon-emotion-theme",
3-
"version": "1.1.0",
3+
"version": "2.0.0",
44
"description": "storybook addon with emotion theme",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)