diff --git a/README.md b/README.md index 30605a4..079f625 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -# tokens \ No newline at end of file +# Tokens + +This repo imports colour variables/tokens from Figma using Figma's API, and uses Style Dictionary to transform those tokens to CSS, Android and iOS. + +## How to use + +First time do a pnpm install to make sure all packages are installed: + +```sh +pnpm install +``` + +And then run the whole script: +```sh +pnpm build +``` + +Note: Never commit your FIGMA Token. Also make sure your FIGMA Token has access to the project \ No newline at end of file