@kroo-web/design-system 1.0.16 → 1.0.18

package/README.md

@@ -0,0 +1,44 @@
+# Kroo Web Component Lib / Design system
+
+## Usage
+
+First, install the package with whatever flavour of package manager that you would like.
+
+### Install
+
+```bash
+  npm install @kroo-web/design-system -S
+```
+or
+```bash
+  yarn add @kroo-web/design-system -S
+```
+or
+```bash
+  pnpm add @kroo-web/design-system -S
+```
+
+### Tokens
+
+Next, add the following the highest up in your application, usually in the `App.js` or `index.js` file.
+
+This adds the tokens used in the design system to the root of the application. (the css modules come prebundled in the build this step is only for the tokens and odd global styles included in the design system).
+
+```jsx
+import '@kroo-web/design-system/dist/styles/global.css';
+```
+
+That's all folks! You can now use the components in the design system in your application.
+
+```jsx
+import { TextField } from '@kroo-web/design-system';
+```
+
+
+## Next Steps
+
+This sways more on the side of component library rather than a design system due to the lack of tokens and living documentation. However, next steps would be to create a seperate package called @kroo-web/tokens allowing us to version the tokens and use them in the design system. 
+
+We could also use Token Studio with Figma to enable the designers to have control over the tokens allowing them to change the design system and see the changes in the design system in real time.
+
+

package/dist/cjs/index.d.ts

@@ -1 +1 @@
-export * from "./product/components";
+export * from './product/components';