Add readme

warp-ds · May 22, 2024 · f2b5620 · f2b5620
1 parent e3aeeb9
commit f2b5620
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,18 @@
-# tokens
+# 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