Skip to content

Commit df815d6

Browse files
author
Simon Planinschek
committed
Updated readme.md
1 parent 20c982a commit df815d6

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

readme.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,58 @@
11
React Material Icons
22
====================
3+
4+
This package includes all [Material Icons](https://material.io/resources/icons/?style=baseline) as reusable react components
5+
6+
## Table of content
7+
- [Usage](#usage)
8+
- [Build & Publish](#build--publish)
9+
- [Information](#information)
10+
11+
## Usage
12+
13+
In order to use this package you have to install it through npm
14+
```bash
15+
npm install @aboutbits/react-material-icons
16+
```
17+
18+
After you successfully installed the package you can simply use the icons in you react application like this
19+
```jsx
20+
import React from 'react'
21+
22+
const MyCommponent = () => {
23+
return (
24+
<IconCached />
25+
);
26+
}
27+
```
28+
29+
SVG related parameters like height and width can be passed as props
30+
31+
## Build & Publish
32+
33+
To build and publish the package, simply commit all changes and push them to master. Then run one of the following commands locally:
34+
35+
```bash
36+
npm version patch
37+
npm version minor
38+
npm version major
39+
```
40+
41+
## Information
42+
43+
About Bits is a company based in South Tyrol, Italy. You can find more information about us on [our website](https://aboutbits.it).
44+
45+
### Support
46+
47+
For support, please contact [info@aboutbits.it](mailto:info@aboutbits.it).
48+
49+
### Credits
50+
51+
- [Simon Planinschek](https://github.com/stplasim)
52+
- [Alex Lanz](https://github.com/alexlanz)
53+
- [Martin Malfertheiner](https://github.com/mmalfertheiner)
54+
- [All Contributors](../../contributors)
55+
56+
### License
57+
58+
The MIT License (MIT). Please see the [license file](license.md) for more information.

0 commit comments

Comments
 (0)