README
evernest-icons
- SVG icons for use in Evernest projects
- The package is published on npm
- Supports sizes
16px
,24px
and40px
How to use
Step 1 - Github
- Create a new branch
- Add the new icon file(s) to the
icons/in
folder with the name template<name> <size>.svg
.- For example, if your file was a 16px SVG called
building.svg
, you would rename the file tobuilding 16px.svg
and place it into theicons/in
folder.
- For example, if your file was a 16px SVG called
- Run
yarn build
, which will automatically compress the new icons, adding them toicons/out
, and update the types for the package. - Commit all of the changes to your branch.
Step 2 - Release
- Once the PR has been approved and merged to master,
git pull
on your local master - Log in to NPM using
npm login
- Run
yarn release
. This will create the tag and version commit. - Run
git push --follow-tags origin master && npm publish
, which will push the new tag & commit to master and publish the new package version on NPM.