@bcgov/design-system-react-components 0.8.1-pr869 → 0.8.1-pr870
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 +8 -0
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/esm/index.js.map +1 -1
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -17,6 +17,14 @@ If you have questions, you can:
|
|
|
17
17
|
|
|
18
18
|
`npm install @bcgov/design-system-react-components`
|
|
19
19
|
|
|
20
|
+
### Using this library with LLMs
|
|
21
|
+
|
|
22
|
+
Instructions for AI agents are shipped with this library (`/node_modules/@bcgov/design-system-react-components/AGENTS.md`).
|
|
23
|
+
|
|
24
|
+
Add the B.C. Design System boilerplate from [AGENTS.example.md](https://github.com/bcgov/design-system/blob/main/AGENTS.example.md) to an `AGENTS.md` file at the root of your project. This directs agents to load the library-specific instructions.
|
|
25
|
+
|
|
26
|
+
Run `/context` to confirm that your agent has loaded the instructions into its context window.
|
|
27
|
+
|
|
20
28
|
### BC Sans font dependency
|
|
21
29
|
|
|
22
30
|
This package installs [@bcgov/bc-sans](https://www.npmjs.com/package/@bcgov/bc-sans) as a peer dependency. You must import the font-face declarations from @bcgov/bc-sans and ensure the font is reachable for your end user. The React components require that the `BC Sans` font-face is available to display correctly. The components do not ship their own copies of the font to minimize your bundle size.
|