Skip to content

Commit

Permalink
Merge pull request #10 from JuzerShakir/update-readme
Browse files Browse the repository at this point in the history
Update Readme
  • Loading branch information
JuzerShakir authored May 4, 2024
2 parents af732c5 + 22742fc commit 0b5c1ba
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 5 deletions.
52 changes: 47 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,50 @@
# React + Vite
<div align="center">
<img src="src/assets/logo.png" width="128"/>
<h2>Scrapulator</h2>
<p>The easiest way to calculate cash for all your scrap items.</p>
</div>

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
<div align="center">

Currently, two official plugins are available:
<!-- HTML -->
<img src="https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white">

- [@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 -->

![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)

<!-- REACT -->

![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)

<!-- VITE -->

![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)

<!-- MORE BADGES visit https://github.com/Ileriayo/markdown-badges -->

</div>

---

### 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.
Binary file added src/assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0b5c1ba

Please sign in to comment.