NoRedInk/noredink-ui
1
1
Fork 0
mirror of https://github.com/NoRedInk/noredink-ui.git synced 2024-09-21 04:07:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README with new script instructions

Browse Source
This commit is contained in:
Tessa Kelly 2024-02-02 11:38:12 -07:00
parent d6d1ae09fa
commit 999157e7f3
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -68,6 +68,17 @@ Contributing to the component library is characterized by close consultation wit
10. When you're ready to publish your component, please refer to [the noredink-ui versioning policy](#versioning-policy), which includes guidance on permitted API changes per release.
11. A11ybats keep an eye on all noredink-ui updates and may request modifications to your work if it does not adhere to the [Component Library Foundations](#component-library-foundations).
**💫 Adding a component to the Component Catalog**
There is a script to help you add your components to the Component Catalog quickly & easily!
Run:
```
$ script/add-example.sh
```
And the script will help you wire up an example page. There will still be some TODOs left for you to fill out. Depending on your component's API, you may also need to adjust the generated code a bit for it to compile.
# Developing, deploying, & versioning
## Getting Started