diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f27374 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# grain + +A small experiment on creating beautiful, dynamic backgrounds with +colorful gradients & film grain. Built in React & Vite with SVGs and layers of Radial Gradients + +### 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 +``` \ No newline at end of file