https://github.com/jossmac/react-icons

Simple component for icons in your React app
https://github.com/jossmac/react-icons

Last synced: 3 months ago
JSON representation

Simple component for icons in your React app

• Host: GitHub
• URL: https://github.com/jossmac/react-icons
• Owner: jossmac
• License: mit
• Archived: true
• Created: 2015-08-04T06:52:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-07T07:41:56.000Z (about 9 years ago)
• Last Synced: 2024-06-29T03:34:45.220Z (4 months ago)
• Language: JavaScript
• Size: 555 KB
• Stars: 13
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# React Icons

__COMPONENT DESCRIPTION GOES HERE__

## Demo & Examples

Live demo: [jossmac.github.io/react-icons](http://jossmac.github.io/react-icons/)

To build the examples locally, run:

```

npm install

npm start

```

Then open [`localhost:8000`](http://localhost:8000) in a browser.

## Installation

The easiest way to use react-icons is to install it from NPM and include it in your own React build process (using [Browserify](http://browserify.org), [Webpack](http://webpack.github.io/), etc).

You can also use the standalone build by including `dist/react-icons.js` in your page. If you use this, make sure you have already included React, and it is available as a global variable.

```

npm install react-icons --save

```

## Usage

__EXPLAIN USAGE HERE__

```

var Icon = require('react-icons');

Example

```

### Properties

* __DOCUMENT PROPERTIES HERE__

### Notes

__ADDITIONAL USAGE NOTES__

## Development (`src`, `lib` and the build process)

**NOTE:** The source code for the component is in `src`. A transpiled CommonJS version (generated with Babel) is available in `lib` for use with node.js, browserify and webpack. A UMD bundle is also built to `dist`, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run `npm start`. If you just want to watch changes to `src` and rebuild `lib`, run `npm run watch` (this is useful if you are working with `npm link`).

## License

__PUT LICENSE HERE__

Copyright (c) 2015 Joss Mackison.