@epilot360/icons 1.3.0 → 1.4.1

package/README.md

@@ -3,17 +3,23 @@
 [![License](http://img.shields.io/:license-mit-blue.svg)](#)
 [![npm version](https://img.shields.io/npm/v/@epilot360/icons.svg)](https://www.npmjs.com/package/@epilot360/icons)
 
-Curated set of epilot icons based on [material-symbols](https://www.npmjs.com/package/material-symbols)
+Curated set of epilot icons based on [material-symbols](https://www.npmjs.com/package/material-symbols).
+
+## Installation
 
 ```
 yarn add @epilot360/icons
 ```
 
+## Documentation
+
+View full list of icons in our [Storybook Documentation](https://portal.dev.epilot.cloud/epilot360-icons/).
 
 ## Usage
 
 The `@epilot360/icons` package is shipped as an external system module in the 360 portal.
 
+
 You can import any icon as a React component by name:
 
 ```tsx
@@ -33,35 +39,27 @@ import EditIcon from '@epilot360/icons/react/Edit'
 
 <EditIcon />
 ```
-import { EpilotIcon } from '@epilot360/icons'
 
-<EpilotIcon name="edit" />
-```
-
-## Usage outside 360 portal
-
-To avoid bundling the entire `@epilot360/icons` library, you can import the module directly:
+## Development
 
-```tsx
-import Edit from '@epilot360/icons/react/Edit'
+Run storybook locally:
 
-<Edit />
+```
+yarn storybook
 ```
 
-Or
+To add a new icon, modify [`icons.config.yaml`](./icons.config.yaml) and run the codegen script.
 
-```tsx
-import { EpilotIcon } from '@epilot360/icons/react'
-
-<EpilotIcon name="edit" />
+```
+yarn codegen
 ```
 
-## Add a new icon
+You should immediately see your new icon.
 
-To add a new icon, modify `icons.config.yaml` and run codegen.
+## Adding custom icons (non Material)
 
-```sh
-yarn codegen
-```
+First add a custom icon to [`icons.config.yaml`](./icons.config.yaml) without an `svg_import` property. This prevents
+codegen from overriding your custom icon module.
 
+Then create the module. See [`src/react/Epilot`](./src/react/Epilot) for an example.