Skip to content

Commit

Permalink
Update README and license field (#1)
Browse files Browse the repository at this point in the history
* docs: add installation and usage guide

* docs: add LICENSE
  • Loading branch information
samshara authored Apr 26, 2023
1 parent b81bd44 commit 5d44a18
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 3 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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 (
<div>
<MenuLine className={{ color: #3b82f6 }} />
</div>
)
}
```
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.
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 5d44a18

Please sign in to comment.