@wellcometrust/wellcome-icons 0.1.1 → 1.0.0

package/README.md

@@ -1,2 +1,45 @@
-# wellcome-icons
-Icons used by Wellcome digital products
+# Wellcome Icons
+
+## Introduction
+These icons can be used across Wellcome's digital products. Currently this repository includes
+a single React component that accepts two props - the `name` of the icon to be used and an optional
+`viewbox` prop that allows for custom viewboxes to be applied to the icons.
+
+We don't provide any styling or wrapper elements for the SVGs - these should be implemented within
+the repository consuming this library.
+
+### Installation
+
+```npm install @wellcometrust/wellcome-icons --save```
+
+
+### Import components
+
+```js
+import { Icon, IconProps } from '@wellcometrust/wellcome-icons';
+
+```
+
+## Contributing to Wellcome Icons development
+
+### Clone this repo
+
+```git clone git@github.com:wellcometrust/wellcome-icons.git```
+
+### Node version and NVM
+
+This repo supports a specific version of Node.js which is specified in [.nvmrc](.nvmrc). It is strongly recommended that you install [NVM](http://nvm.sh/) on your local machine to easily manage multiple versions of Node.
+
+Running `nvm use` from the command line will automatically pick up the version named in the `.nvmrc` file and set this as the node version for the current terminal window.
+
+### Installation
+
+```npm install```
+
+### Build all files
+
+```npm run build```
+
+### Publishing for consumption
+
+New releases are published to NPM. Please speak to a member of the project dev team about this, or consult our documentation in Notion around how to publish to NPM.

package/dist/components/Icon/Icon.js

@@ -0,0 +1 @@
+import e from"react";import t from"../iconMapping.js";const o=({name:o,viewBox:r})=>{if(!Object.prototype.hasOwnProperty.call(t,o))return null;const n=t[o];return e.createElement(n,{viewBox:r})};o.displayName="Icon";export{o as Icon,o as default};