@artilleryio/alpha-centauri-icons
v1.4.10
Published
Alpha Centauri iconography based on Material icons.
Downloads
140
Readme
@artilleryio/alpha-centauri-icons
The supporting iconography of Artillery products.
Installation
Simply run the following...
npm install @artilleryio/alpha-centauri-icons
...and to upgrade:
npm install @artilleryio/alpha-centauri-icons@latest
Usage
For full documentation on each icon, visit our Visualiser.
Using an icon in your project is as simple as...
import { IconBase, IconSuccess } from '@artilleryio/alpha-centauri-components';
...
<IconBase {...props}>
<IconSuccess />
</IconBase>
Contributing
The project is currently bundled together using Rollup. This makes it quite simple to build and publish changes. You will also need to be setup via NPM to be able to publish new versions of the package.
Typically, once you've run npm run lint-fix
from the project root, you can build and publish by:
- Bumping up the version number in
package.json
. - Running
npm run build
in the icon package root. - If everything goes smoothly, you can then simply run
npm publish
and this pushes the latest version of the package to NPM.
You will need to update the package wherever it is in use, in the wild (e.g. Control Panel etc.)
Icon Creation Guide
🚧 Coming soon...
Dependencies
This project relies on some of our other packages, most notably: