storybook 0.2.1 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Storybook (CLI)
|
|
1
|
+
# Storybook (CLI)
|
|
2
2
|
|
|
3
3
|
[](https://greenkeeper.io/)
|
|
4
4
|
[](https://circleci.com/gh/storybooks/storybook)
|
|
@@ -15,7 +15,16 @@ This package provides a CLI for adding [Storybook](https://github.com/storybooks
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
The quickest way to add Storybook to your project is to run this package via [npx](https://www.npmjs.com/package/npx):
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
cd your-project-folder
|
|
22
|
+
npx storybook
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
That's all you've to do.
|
|
26
|
+
|
|
27
|
+
If you don't use npx install this CLI globally.
|
|
19
28
|
|
|
20
29
|
```sh
|
|
21
30
|
npm i -g storybook
|
|
@@ -27,7 +36,21 @@ Then go to your project's folder and run:
|
|
|
27
36
|
storybook
|
|
28
37
|
```
|
|
29
38
|
|
|
30
|
-
|
|
39
|
+
* * *
|
|
40
|
+
|
|
41
|
+
After that run Storybook by
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
npm run storybook
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
or
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
yarn storybook
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
For more information visit: [storybook.js.org](https://storybook.js.org)
|
|
31
54
|
|
|
32
55
|
* * *
|
|
33
56
|
|
|
@@ -52,8 +75,6 @@ It also supports flow files. By default, [jscodeshift](https://github.com/facebo
|
|
|
52
75
|
storybook --parser flow
|
|
53
76
|
```
|
|
54
77
|
|
|
55
|
-
For more information visit: [storybook.js.org](https://storybook.js.org)
|
|
56
|
-
|
|
57
78
|
## Credits
|
|
58
79
|
|
|
59
80
|
npm package: https://www.npmjs.com/package/storybook
|