diff --git a/README.md b/README.md index f768e33..719beca 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,50 @@ -# React + Vite +
+ +

Scrapulator

+

The easiest way to calculate cash for all your scrap items.

+
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +
-Currently, two official plugins are available: + + -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh + + +![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white) + + + +![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) + + + +![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white) + + + +
+ +--- + +### List of Scrap Items + +| Items | Default Earning Values set per KG | +| :-------: | :-------------------------------: | +| Plastic | ₹15 | +| Paper | ₹10 | +| Cardboard | ₹8 | +| Steel | ₹40 | +| German | ₹120 | +| Iron | ₹30 | + +These default earnings can be edited in the web application. + +--- + +### Features + +- ⭐ Use state & props to calculate earnings of each item and total earning in real time. +- ⭐ Use React Router Dom library to set up root and edit page routes. +- ⭐ Use TailwindCSS to style the application. +- ⭐ Use Vite to setup the React application. diff --git a/src/assets/logo.png b/src/assets/logo.png new file mode 100644 index 0000000..f3935fa Binary files /dev/null and b/src/assets/logo.png differ