diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d9f9c41 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 IFRC-GO + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 1fbee80..1c817cc 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -### IFRC-GO Icons Library +## IFRC-GO Icons +React icons for [IFRC-GO](https://github.com/IFRCGo/) project. + +## Installation +```sh +yarn add ifrc-go-icons +#or +npm install ifrc-go-icons +``` + +## Usage + +Each icon can be imported as a react component. +```js +import { MenuLineIcon } from 'ifrc-go-icons'; + +function MyComponent() { + return ( +
+ +
+ ) +} +``` +Each icon has its `stroke` and `fill` property set to `currentColor`. The icon style can be set using the `color` CSS property. + +## License + +This library is MIT licensed. diff --git a/package.json b/package.json index b98bec0..ae8c377 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,11 @@ { "name": "ifrc-go-icons", "version": "1.0.0", - "description": "IFRC-GO icons library", + "description": "IFRC-GO icons library for React.", "keywords": [ "ifrc-go", - "icons" + "icons", + "react" ], "homepage": "https://github.com/IFRCGo/go-icons#readme", "repository": {