Add README

This commit is contained in:
Xevion
2022-11-25 02:23:31 -06:00
parent 02e913d590
commit ad3d5dd602

27
README.md Normal file
View File

@@ -0,0 +1,27 @@
# grain
A small experiment on creating beautiful, dynamic backgrounds with
colorful gradients & film grain. Built in <b>React</b> & <b>Vite</b> with <b>SVGs</b> and layers of <b>Radial Gradients</b>
### Dependencies Used
- Hero Icons
- React
- Typescript
- Vite
- Sass
### Installation
- Built on Node v16, packages managed with Yarn.
```bash
npm install --global yarn # If you don't have yarn installed
yarn # Run inside root directory to install all dependencies.
```
### Development
```bash
yarn dev # Starts a development server with Hot Module Replacement
```