Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Marvin Dalheimer authored and Marvin Dalheimer committed Apr 3, 2017
1 parent ab0e14c commit 3146eee
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# React-OpenWebIcons
## usage
# react-openwebicons

> A React component for the OpenWebIcons webfont.
## Install

```bash
npm install --save react-openwebicons
```

## Usage

```JavaScript
//index.jsx
import React from 'react';
import ReactDOM from 'react-dom';
import OpenWebIcon from 'react-openwebicons';

ReactDOM.render(<OpenWebIcon name="openwebicons-epub" size="248px" colored={true}/>, document.getElementById("app"));
ReactDOM.render(<OpenWebIcon name="openwebicons-epub" size="248px" colored="#990000"/>, document.getElementById("app2"));
ReactDOM.render(<OpenWebIcon name="openwebicons-epub" size="248px"/>, document.getElementById("app3"));
ReactDOM.render(<OpenWebIcon name="openwebicons-epub"/>, document.getElementById("app4"));
```

For more informations have a look at the example folder.

## How to develop

- npm/yarn install
- npm run build
- npm link
Expand All @@ -9,4 +35,4 @@
- webpack
- open index.html in web browser

To change the icon, size or color adjust the values in the index.tsx in the example folder and run webpack again
To change the icon, size or color adjust the values in the index.tsx in the example folder and run webpack again

0 comments on commit 3146eee

Please sign in to comment.