@pingux/astro 1.25.1-alpha.0 → 1.25.1-alpha.1
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 +4 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,10 +19,11 @@ Yarn:
|
|
|
19
19
|
|
|
20
20
|
## Usage
|
|
21
21
|
|
|
22
|
-
All apps should be wrapped in an
|
|
22
|
+
All apps should be wrapped in an `<AstroWrapper>` for full functionality and styling.
|
|
23
23
|
|
|
24
24
|
```
|
|
25
|
-
|
|
25
|
+
import { AstroWrapper } from ‘@pingux/astro’;
|
|
26
|
+
|
|
26
27
|
<AstroWrapper>
|
|
27
28
|
<App />
|
|
28
29
|
</AstroWrapper>
|
|
@@ -34,7 +35,7 @@ Astro uses [Storybook](https://storybook.js.org/) for component documentation. O
|
|
|
34
35
|
|
|
35
36
|
`yarn && yarn start`
|
|
36
37
|
|
|
37
|
-
The Storybook server defaults to
|
|
38
|
+
The Storybook server defaults to `https://localhost:6006`. This port can be customized by running the command start -p 9009. For example, this will start Storybook on port 9009. More information on customizing Storybook CLI options can be found at https://storybook.js.org/docs/react/api/cli-options.
|
|
38
39
|
|
|
39
40
|
Component prop documentation is available under the “documentation” tab per each component story. Most props can be toggled and configured for preview purposes within the prop table.
|
|
40
41
|
|
|
@@ -63,12 +64,6 @@ Astro’s [changelog](CHANGELOG.md) notes all features and bug fixes within each
|
|
|
63
64
|
|
|
64
65
|
Astro is closed for open contributions. However, we are appreciative of bug reports and suggestions. Please use GitHub Issues to submit bug reports and suggestions.
|
|
65
66
|
|
|
66
|
-
|
|
67
|
-
## Roadmap
|
|
68
|
-
|
|
69
|
-
Astro is currently in a beta stage. For more information on when 1.0.0 will be released keep an eye out for our upcoming roadmap.
|
|
70
|
-
|
|
71
|
-
|
|
72
67
|
## Licensing
|
|
73
68
|
|
|
74
69
|
This project is licensed under the Apache license. See the [LICENSE](LICENSE) file for more information.
|