Updated the readme

Author: leontm-dev

README.md

@@ -1,94 +1,36 @@
-# Chrome Extension Starter with Vite, React, TypeScript, and Tailwind CSS
-This project is a starter template for building modern Chrome extensions using Vite, React, TypeScript, and Tailwind CSS. It simplifies the setup so you can focus on building your extension's features.
+# pracc-optimiter Extension
 
-<div style="display: flex; justify-content: space-around">
-  <img src="https://github.com/user-attachments/assets/b2267b19-1618-4797-8e0e-a241697b92cf" alt="image 1" width="200"/>
-  <img src="https://github.com/user-attachments/assets/eb6304c9-afd7-4bfc-b9ce-8099531a66d9" alt="image 2" width="200"/>
-  <img src="https://github.com/user-attachments/assets/7808d29d-d1ca-4287-b82b-183ad7b6510a" alt="image 3" width="200"/>
-  <img src="https://github.com/user-attachments/assets/c2f328e2-f7d6-4e6d-a3ec-8e750625e0f8" alt="image 4" width="200"/>
-</div>
+This extension allows you to enhance your experience on the pracc.com site. Use the built-in UI to toggle certain settings that will enable to do improve your experience.
 
-## View tutorial on YouTube
- <a href="https://www.youtube.com/watch?v=jwDErziR1nE">
-    <img src="http://i.ytimg.com/vi/jwDErziR1nE/hqdefault.jpg" alt="YouTube video" width="200"/>
-  </a>
+Current version: v0.1.0
 
-## Features
-- **Fast reloading** develop UI faster, view the popup and options page
-- **Vite** for fast bundling and development
-- **React** for building interactive UI components
-- **TypeScript** for type-safe JavaScript development
-- **Tailwind CSS** for easy and responsive styling
-- **chrome-types** Chrome's API TS files for auto-completion 
+The whole project is not associated with pracc.com or any other brand cooperating with them. It is just a side-project. If you got any copyright issues, please write an email to
+[lanneken09@gmail.com](mailto:lanneken09@gmail.com) (only business inquires)
+
+## License
+
+[MIT](https://github.com/leontm-dev/pracc-optimizer/blob/main/LICENSE)
 
 ## Installation
 
-### Clone this repository:
-```
-git clone https://github.com/omribarmats/chrome-extension-starter.git new-project
-```
-* Replace `new-project` with your project name
+I hope that I will be able to upload this extension to the chrome webstore for easier downloads but at the moment, follow this tutorial:
 
-### Open the new directory:
-```
-cd new-project
-```
-### Install dependencies:
-```
-npm install
-```
-### Start the development server:
-```
-npm run dev
-```
-## Load the Extension
+1. Clone this repo by running: `git clone https://github.com/leontm-dev/pracc-optimizer.git my-extension-folder`
+2. Get into the newly created folder with `cd my-extension-folder`
+3. Run `npm run build`, for this you need to have [Node.js](https://nodejs.org/en) installed
+4. Go to the extensions manager of your browser, for Chrome you will find it under [chrome://extensions](chrome://extensions)
+5. Click on the button that says "Load unpacked"
+6. Now your file manager should have opened, navigate to the folder "my-extension-folder" and click on "dist". Select this folder and the window should lead you back to chrome.
+7. You are done
 
-1. Run the build command: `npm run build.`
-2. Go to `chrome://extensions/` in your Chrome browser.
-3. Enable `Developer mode`.
-4. Click `Load unpacked` and select the `dist` folder from the project.
+## Contributing
 
-## Development
-- Hot-reload enabled for easier development.
-- Modify your code in the src folder.
-- Tailwind CSS is already configured and ready to use.
-- Run `nmp run build` to implement changes to `dist` folder
-- Go on `chrome://extensions/` and click refresh `⟳`
+Contributions are always welcome!
 
-### How to change the popup? 
-- Go on `src/chrome-extension/popup/index.tsx`
-- Once changes are made open the terminal and run `nmp run build` then visit `chrome://extensions/` and click the refresh `⟳` button on your extension
+See `contributing.md` for ways to get started.
 
-### How to change the options page? 
-- Go on `src/chrome-extension/options/index.tsx`
-- Once changes are made open the terminal and run `nmp run build` then visit `chrome://extensions/` and click the refresh `⟳` button on your extension
+Please adhere to this project's `code of conduct`.
 
-- ### How to add a background script? 
-- Create a `background.ts` file inside the `src` folder
-- Go on `vite.config.ts` and add this line `background: resolve(__dirname, "src/background.ts"),` under `build.rollupOptions.input`
-- For example 
-```
- build: {
-    rollupOptions: {
-      input: {
-        popup: resolve(__dirname, "popup.html"),
-        options: resolve(__dirname, "options.html"),
-        background: resolve(__dirname, "src/background.ts"),
-      },
-      output: {
-        entryFileNames: "[name].js",
-      },
-    },
-  },
-```
-- Go on `manifest.json` and add this code:
-```
-  "background": {
-    "service_worker": "background.js",
-    "type": "module"
-  }
-``` 
-- Open the terminal and run `nmp run build` then visit `chrome://extensions/` and click the refresh `⟳` button on your extension
+## Authors
 
-## Contributing
-Feel free to fork the project and make improvements or submit bug reports or issues.
+- [@leontm-dev](https://www.github.com/leontm-dev)