diff --git a/README.md b/README.md index 4408e29..f21fdb3 100644 --- a/README.md +++ b/README.md @@ -1 +1,97 @@ -# coolshapes +#
Coolshapes
+ + + +### What & Why? +A simple, fun project for the sake of creating some cool-looking abstract shapes with little grainy gradients crafted by [@realvjy](https://x.com/realvjy). Coolshapes is a completely open-source set of 100+ abstract shapes crafted for any design and development projects. Free for both commercial and personal use. Licensed under MIT. + + +## Table of Contents + +- [Usage](#usage) + - [React](#react) +- [Contributing](#contributing) +- [Community](#community) +- [License](#license) +- [Credits](#credits) +- [Sponsors](#sponsors) + +## Usage + +At its core, Coolshapes is a collection of [SVG](https://coolshap.es) files. This means that you can use this in all the same ways you can use SVGs (e.g. `img`, `background-image`, `inline`, `object`, `embed`, `iframe`). + +The following are ways you can use Coolshapes. + + + +# Coolshapes React + +Implementation of the coolshapes icon library for react applications. + + +## How to use + +It's built with ES modules so it's completely tree-shakable. +Each icon can be imported as a react component. + + +Implementation of the coolshapes icon library for web applications. + +```sh +npm install coolshapes-react +``` + +or + +```sh +yarn add coolshapes-react +``` +### Example + +You can pass additional props to adjust the icon. + +```js +import { Coolshape } from 'coolshapes-react'; + +const App = () => { + return