Skip to content

Commit ff7f349

Browse files
committed
rename to rescript-storybook
1 parent 4704077 commit ff7f349

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# bs-storybook
1+
# rescript-storybook
22

3-
BuckleScript bindings for **[Storybook](https://storybook.js.org/)**.
3+
Rescript bindings for **[Storybook](https://storybook.js.org/)**.
44

55
The goal of this project is to provide bindings for the main Storybook API, as well as the official add-ons. Currently it supports:
66

@@ -13,10 +13,10 @@ The goal of this project is to provide bindings for the main Storybook API, as w
1313
First install this package:
1414

1515
```bash
16-
npm install bs-storybook
16+
npm install rescript-storybook
1717
```
1818

19-
Next, you'll need to add `bs-storybook` to your `bsconfig.json` as a dependency.
19+
Next, you'll need to add `rescript-storybook` to your `bsconfig.json` as a dependency.
2020

2121
Then, get Storybook up and running according to [their docs](https://storybook.js.org/basics/quick-start-guide/)
2222

@@ -48,7 +48,7 @@ module.exports = {
4848
};
4949
```
5050

51-
Note that in the above example, we're assuming the convention of each module containing a function as the `default` export. bs-storybook is accountable for that while writting your stories:
51+
Note that in the above example, we're assuming the convention of each module containing a function as the `default` export. rescript-storybook is accountable for that while writting your stories:
5252

5353
## Writing a story
5454

@@ -60,7 +60,7 @@ open BsStorybook.Story;
6060
let _module = [%bs.raw "module"];
6161
6262
storiesOf("My First Reason Story", _module)
63-
->add("Chapter I", () => <span> {React.string("Hello bs-storybook!")} </span>);
63+
->add("Chapter I", () => <span> {React.string("Hello rescript-storybook!")} </span>);
6464
```
6565

6666
Storybook uses a reference to the `module` global provided by webpack to facilitate hot-reloading. We'll access that via the `[%bs.raw]` decorator.

0 commit comments

Comments
 (0)