@alto-avios/alto-ui 1.0.1 → 1.1.0-alpha.0

package/README.md

@@ -2,6 +2,92 @@
 
 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/IAG-Loyalty/alto-ui/blob/main/LICENSE)
 
+[Zeroheight Documentation](https://zeroheight.com/8d62898ee/p/69c136-how-to-use-components)
+
+## Install Package
+
+Install the Avios Alto Component Library package 
+
+`npm install @alto-avios/alto-ui`
+
+## Install Design Tokens
+
+Add the following scripts to your `package.json`
+
+```json
+"scripts": {
+    ... ,
+    "build-tokens": "npx tsx ./node_modules/@alto-avios/alto-tokens/config.ts",
+    "clean-tokens": "rm -rf alto-tokens"
+},
+```
+
+Build your generated tokens using the following command
+
+`npm run build-tokens`
+
+Your newly generated tokens can be found in a folder named: `~/alto-tokens`
+
+Place the design token package into your `src` directory.
+
+## Import Fonts
+
+Download the font assets from this repository: https://github.com/va1-a/dali-fonts and add them to your project.
+
+## Importing Alto Components
+
+After following the installation process, you can import and use Alto-UI components in your React application. Here is an example of how to do it.
+
+```jsx
+import React from 'react';
+import { Button } from '@alto-avios/alto-ui';
+
+const App = () => (
+  <div>
+    <Button>Click Me!</Button>
+  </div>
+);
+
+export default App;
+```
+
+## Update
+
+Check if an update exists:
+
+`npm outdated`
+
+If an update is available, update the package:
+
+`npm i @alto-avios/alto-ui@latest`
+
+## Dependencies
+
+### Node
+
+Make sure to use Node -v `20.11.1`.
+
+Follow these steps to verify and install the required Node.js version for this project:
+Open your terminal.
+
+Check the current version of Node.js installed on your system by running the following command:
+
+`node -v`
+​
+Check the output. If it is not version `20.11.1`, you will need to install this version.
+
+If you don't have a Node version manager, install one. We recommend using NVM (Node Version Manager).
+
+Install Node.js version 20.11.1 using your version manager. If you're using NVM, the command is:
+
+`nvm install 20.11.1`
+​
+Once the installation is complete, verify the installation by checking the Node.js version again:
+
+`node -v`
+​
+The output should now be 20.11.1. You can now proceed with the project setup.
+
 ## License
 
 This project is licensed under the terms of the