@cargosense/cargo-design-system 1.0.1 → 1.0.4

package/README.md

@@ -2,6 +2,24 @@
 
 This is the repository for the CargoSense Design System node package. The documentation for is hosted at https://docs.cargosense.com/design-system-docs.
 
+## Usage
+
+Include these lines in your project:
+
+```js
+// In your script.js file
+import { registerAllComponents } from '@cargosense/cargo-design-system/register'
+registerAllComponents();
+
+// Or to import a specific component
+import { registerButton } from '@cargosense/cargo-design-system/register'
+registerButton();
+
+import '@cargosense/cargo-design-system/fonts'; // Import fonts
+import "@cargosense/cargo-design-system/styles"; // Import CSS Variables
+
+```
+
 ## Organization
 
 There are many different directory style structures for design systems, we will be adhering to a molecular structure where **atoms** are the smallest, most basic components (such as badges, icons, Key/Value pairs, etc). **Molecules** are larger components, usually those which rely on the smaller atom components to make up the bigger component as well. **Organisms** are either bigger components on the page or components that use several molecules/atoms. **Templates** are fully built out pages.