@ecoportal/icons 0.0.2 → 1.0.1

package/README.md

@@ -0,0 +1,25 @@
+# @ecoportal/icons
+
+NPM Package for ecoPortal React Icons in the design system. [package](https://www.npmjs.com/package/@ecoportal/icons).
+
+## Development
+
+### Adding/removing icons
+
+The icon set is controlled by the `src/icons` directory. Any icons in there will be built via `yarn icons`. To add or remove icons just add or remove the .svg file.
+
+### Building
+
+Clone the repository and add icons to `src/icons`
+
+1. Run `yarn icons` to build the icons into a `src/index.ts` file.
+2. Run `yarn build` to bundle the icons for publishing.
+3. Run `yarn publish` to publish the new icons to NPM.
+
+## Icon Guidelines
+
+All icons in the `src/icons` directory should be in a top level `Category` folder e.g. `Buildings/building-single.svg`. The icons are served via an svg file. If an svg is made of all single color `path`s then they should not have a fill set to allow easy styling wherever imported.
+
+## Linking without publishing
+
+If you wish to add icons to the package and test them somewhere else without publishing in this repo run `npm link` to create a global link on your machine. Then, navigate to the other project consuming `@ecoportal/icons` and run `npm link @ecoportal/icons` in that project. This will create a symlink between the local build of this package and what is consumed in the other project. Once happy publish.