@usearcade/arcade-js

Make Arcade a dependency in your project and access your design tokens with ease

Usage no npm install needed!

<script type="module">
  import usearcadeArcadeJs from 'https://cdn.skypack.dev/@usearcade/arcade-js';
</script>

README

@usearcade/arcade-js

Version Documentation Maintenance Twitter: usearcade License: GPL-3.0

Make Arcade a dependency in your project and access your design tokens with ease

🏠 Homepage

Install

npm install @usearcade/arcade-js

Usage

When this package is installed, arcade-config.json will be added to the root of your repository. Within this file, make sure to add your project_id, access_token, and version to ensure the install will work. These details can be found within your Arcade project.

The install will add two scripts to your package.json:

Build Tokens

  npm run arcade-build

This command will fetch your tokens from Arcade and build them locally using the configuration in arcade-config.json.

Update Tokens

  npm run arcade-update

This command will fetch the latest published tokens from Arcade and build them locally using the configuration in arcade-config.json. The version number in arcade-config.json does not have to be manually changed and will be updated automatically.

Author

👤 Arcade Inc.

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

📝 License

Copyright © 2021 Arcade Inc.
This project is GPL-3.0 licensed.

This README was generated with ❤️ by readme-md-generator