Skip to content

Commit 0dcdee2

Browse files
author
Simon Planinschek
committed
Updated readme.md with required changes
1 parent 815ef0a commit 0dcdee2

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

readme.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
React Material Icons
22
====================
33

4-
This package includes all [Material Icons](https://material.io/resources/icons/?style=baseline) as reusable react components
4+
This package includes all [Material Icons](https://material.io/resources/icons/?style=baseline) as reusable React components
55

66
## Table of content
77
- [Usage](#usage)
8+
- [Generate Component](#generate-component)
89
- [Build & Publish](#build--publish)
910
- [Information](#information)
1011

@@ -15,7 +16,7 @@ In order to use this package you have to install it through npm
1516
npm install @aboutbits/react-material-icons
1617
```
1718

18-
After you successfully installed the package you can simply use the icons in you react application like this
19+
After you successfully installed the package you can simply use the icons in you React application like this
1920
```jsx
2021
import React from 'react'
2122

@@ -28,13 +29,14 @@ const MyCommponent = () => {
2829

2930
SVG related parameters like height and width can be passed as props
3031

31-
## Build & Publish
32-
33-
To build the package, simply run the following command
32+
## Generate Component
33+
To generate the components, simply run the following command
3434
```bash
3535
npm run build
3636
```
3737

38+
## Build & Publish
39+
3840
To publish the package commit all changes and push them to master. Then run one of the following commands locally:
3941
```bash
4042
npm version patch

0 commit comments

Comments
 (0)