[![Contributors][contributors-shield]][contributors-url]
[![MIT License][license-shield]][license-url]
![top-languages-shield]
![languages-count-shield]
![package-version-shield]
![npm-monthly-downloads-shield]
Table of Contents
-
About React Crypto Icons
-
Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
## About React Crypto Icons
React Crypto Icons provides a simple React component that can be used to display crypto logos. This project supports nearly 600 (okay 594) SVG icons taken from the [cryptocurrency-icons][cryptocurrency-icons] project. You can check out the supported icons [here](http://cryptoicons.co/)!
### Built With
This library requires the following packages to be installed:
* [React.js][react] v18.2.0+
* [react-dom ][react-dom] v18.2.0+
## Getting Started
Getting React Crypto Icons integrated with your project is a breeze! Just install using the node package manager of your choosing and _voilà_!
### Prerequisites
React Crypto Icons requires [Node.js][nodejs] v12+ to run.
### Installation
Install React Crypto Icons from npm
```sh
npm install react-crypto-icons
```
Or with yarn
```sh
yarn add react-crypto-icons
```
## Usage
All icon names should be lowercase to avoid capitalization mismatching. To ensure consistant icon sizing, you **MUST** specify a size for each icon.
```js
import React from "react";
import Icon from "react-crypto-icons";
function App() {
return (
);
}
export default App;
```
_Pretty much all there is to it :)_
## Roadmap
- [x] Add Changelog
- [ ] Add Additional Example Docs
- [ ] Add Live Demo
See the [open issues][github-issues] for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch
```sh
git checkout -b feature/AmazingFeature
```
3. Commit your Changes
```sh
git commit -m 'Add some AmazingFeature'
```
4. Push to the Branch
```sh
git push origin feature/AmazingFeature
```
6. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
**Free Software, Yee Haw!**
## Contact
rogdevil - sep2001aryan@yahoo.com
back to top
[github-url]: https://github.com/rogdevil/crypto-icons
[github-issues]: https://github.com/rogdevil/crypto-icons/issues
[repo-path]: rogdevil/crypto-icons
[logo-path]: assets/img/logo
[nodejs]: https://nodejs.org/
[react]: https://www.npmjs.com/package/react
[react-dom]: https://www.npmjs.com/package/react-dom
[cryptocurrency-icons]: https://github.com/spothq/cryptocurrency-icons
[license-shield]: https://img.shields.io/github/license/rogdevil/crypto-icons.svg?style=for-the-badge
[license-url]: https://github.com/rogdevil/crypto-icons/blob/main/LICENSE.txt
[package-version-shield]: https://img.shields.io/github/package-json/v/rogdevil/crypto-icons.svg?style=for-the-badge
[build-status-shield]: https://img.shields.io/travis/com/rogdevil/crypto-icons.svg?style=for-the-badge
[contributors-shield]: https://img.shields.io/github/contributors/rogdevil/crypto-icons.svg?style=for-the-badge
[contributors-url]: https://github.com/rogdevil/crypto-icons/graphs/contributors
[npm-monthly-downloads-shield]: https://img.shields.io/npm/dt/react-crypto-icons?style=for-the-badge
[npm-monthly-downloads-url]: https://www.npmjs.com/package/react-crypto-icons
[top-languages-shield]: https://img.shields.io/github/languages/top/rogdevil/crypto-icons.svg?style=for-the-badge
[languages-count-shield]: https://img.shields.io/github/languages/count/rogdevil/crypto-icons.svg?style=for-the-badge