README.md

React Crypto Icons

A simple React component that can display 600 crypto icons

Report Bug · Request Feature

Table of Contents

1. About React Crypto Icons
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. 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 project. You can check out the supported icons here!

Built With

This library requires the following packages to be installed:

• React.js v17.0.2+
• react-dom v17.0.2+

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 v12+ to run.

Installation

Install React Crypto Icons from npm

npm install react-crypto-icons

Or with yarn

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.

import React from "react";
import Icon from "react-crypto-icons";

function App() {
    return (
        <div className="App">
            <Icon name="btc" size={25} />
        </div>
    );
}

export default App;

Pretty much all there is to it :)

Roadmap

• Add Changelog
• Add Additional Example Docs
• Add Live Demo

See the open 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

   git checkout -b feature/AmazingFeature

3. Commit your Changes

   git commit -m 'Add some AmazingFeature'

4. Push to the Branch

    git push origin feature/AmazingFeature

5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information. Free Software, Yee Haw!

Contact

Riley Stephens - [email protected]

back to top