diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4f4e458 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,137 @@ +# 🪛 Want to contribute? + +### We would love for you to join us! + +- **BookMark🔖** is an open-source project, and we are excited to hear your thoughts and ideas. +- Fork this repository, add your contributions, and submit a pull request (PR). +- Have you found a bug, an accessibility issue, or do you want to add a new feature? Go right ahead and create an issue. + +# 🛠️ Tech Stack + +This project uses:

+![HTML](https://img.shields.io/badge/🗽_html-%23000000.svg?style=for-the-badge&logo=html&logoColor=%2361DAFB) +![Css](https://img.shields.io/badge/🎨_css-%23000000.svg?style=for-the-badge&logo=css&logoColor=%2361DAFB) +![JavaScript](https://img.shields.io/badge/javascript-%23000000.svg?style=for-the-badge&logo=javascript&logoColor=%FFFF00) + + + +# Prerequisites + +### Before installation, you need to have installed/knowledge of the following: +![Chrome](https://img.shields.io/badge/chrome_Browser-6DA55F?style=for-the-badge&logo=chrome&logoColor=white) +![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white) + +
+ +## This Extension is not yet published on the Chrome Web Store

+ +# **To Test/contribute to this extension, follow the steps below:**

+ + +### How to contribute to this Extension from the Repository + +1. Fork the repository (Click the Fork button in the top right of this page, + click your Profile Image) +2. Clone the forked repository to your local machine. + +```markdown +git clone https://github.com/your-username/BookMark.git +``` + +3. change the present working directory + +```markdown +cd BookMark +``` + +4. Open **Google Chrome** browser and click on the **three dots** on the upper right side of the browser. Then go to **More Tools** and click on **Extensions** as shown below: + +Screenshot-from-2023-04-21-11-09-52 + +5. then you can see a developer mode switch on the right upper side of the screen click on that to enable the Developer mode + +Screenshot-from-2023-04-21-11-09-08 + +6. After that, click on **load unpacked** on the left upper side of the screen and select the **BookMark** repo that you have cloned on your computer. + +Screenshot-from-2023-04-21-11-08-30 + +7. For better usage, click on the puzzle icon on the upper right of the browser, then click on the pin icon on MY Bookmarks. + +Screenshot-from-2023-04-22-13-47-03 + +## Using the extention +- Open the website that you want to bookmark. +- Click on the **BookMark** extension icon. +- A user interface similar to this will appear: + +Screenshot-from-2023-04-22-13-51-10 +

+Screenshot-from-2023-04-22-13-51-56 + +- Now, click on the **Save Bookmark** button. Then, you will see an input field where you can enter the title you want to give to the bookmark. +- You can either give a custom name or leave it empty. If you leave it empty, it will save using the default name. + +Screenshot-from-2023-04-22-13-52-23 + +- You will see the bookmark on the extensions space. +- You can click on the title to visit the website. + +Screenshot-from-2023-04-22-13-57-14 + +### Deleting the bookmark +- To remove a bookmark from the list, simply click on the **Remove** button next to the title, and it will be removed from the list. + +Screenshot-from-2023-04-22-13-54-15 +Screenshot-from-2023-04-22-13-54-31

+ +# Pull request : +1. Make the nessasary changes in the project. Add, Commit and push the project using following commands: + +> Add all files + +```markdown +git add . +``` + +> Commit the changes + +```markdown +git commit -m "Write Your commit Message" +``` + +> Create a new branch + +```diff +git branch -M +``` + +> Set upstream command to create a PR + +```diff +git remote add upstream https://github.com/JasonDsouza212/BookMark.git +``` + +> Push the branch + +```markdown +git push +``` + +### NOTE + +- Make Sure you commit your changes in a new branch. +- Make Sure you Give proper name to your files describing the addition. +- Also Make Sure you comment your code wherever necessary. + +## ✨ Contributors + + + + + +
+
+

Show some ❤️ by starring this awesome repository!

+
+ diff --git a/INSTALLATION.md b/INSTALLATION.md new file mode 100644 index 0000000..ff0261e --- /dev/null +++ b/INSTALLATION.md @@ -0,0 +1,95 @@ +# 📥 Want to Use/Install the Extention? + +### We would love for you to join us! + +- **BookMark🔖** is an open-source project, and we are excited to hear your thoughts and ideas. + +# 🛠️ Tech Stack + +This project uses:

+![HTML](https://img.shields.io/badge/🗽_html-%23000000.svg?style=for-the-badge&logo=html&logoColor=%2361DAFB) +![Css](https://img.shields.io/badge/🎨_css-%23000000.svg?style=for-the-badge&logo=css&logoColor=%2361DAFB) +![JavaScript](https://img.shields.io/badge/javascript-%23000000.svg?style=for-the-badge&logo=javascript&logoColor=%FFFF00) + + + +# Prerequisites + +### Before installation, you need to have installed/knowledge of the following: +![Chrome](https://img.shields.io/badge/chrome_Browser-6DA55F?style=for-the-badge&logo=chrome&logoColor=white) + +
+ +## This Extension is not yet published on the Chrome Web Store

+ +# **To install this extension for personal use, follow the steps below:**

+ + +### How to Use this Extension from the Repository + +1. Fork the repository (Click the Fork button in the top right of this page, + click your Profile Image) +2. Clone the forked repository to your local machine. + +```markdown +git clone https://github.com/your-username/BookMark.git +``` + +3. change the present working directory + +```markdown +cd BookMark +``` + +4. Open **Google Chrome** browser and click on the **three dots** on the upper right side of the browser. Then go to **More Tools** and click on **Extensions** as shown below: + +Screenshot-from-2023-04-21-11-09-52 + +5. then you can see a developer mode switch on the right upper side of the screen click on that to enable the Developer mode + +Screenshot-from-2023-04-21-11-09-08 + +6. After that, click on **load unpacked** on the left upper side of the screen and select the **BookMark** repo that you have cloned on your computer. + +Screenshot-from-2023-04-21-11-08-30 + +7. For better usage, click on the puzzle icon on the upper right of the browser, then click on the pin icon on MY Bookmarks. + +Screenshot-from-2023-04-22-13-47-03 + +## Using the extention +- Open the website that you want to bookmark. +- Click on the **BookMark** extension icon. +- A user interface similar to this will appear: + +Screenshot-from-2023-04-22-13-51-10 +

+Screenshot-from-2023-04-22-13-51-56 + +- Now, click on the **Save Bookmark** button. Then, you will see an input field where you can enter the title you want to give to the bookmark. +- You can either give a custom name or leave it empty. If you leave it empty, it will save using the default name. + +Screenshot-from-2023-04-22-13-52-23 + +- You will see the bookmark on the extensions space. +- You can click on the title to visit the website. + +Screenshot-from-2023-04-22-13-57-14 + +### Deleting the bookmark +- To remove a bookmark from the list, simply click on the **Remove** button next to the title, and it will be removed from the list. + +Screenshot-from-2023-04-22-13-54-15 +Screenshot-from-2023-04-22-13-54-31 + +## ✨ Contributors + + + + + +
+
+

Show some ❤️ by starring this awesome repository!

+
+ diff --git a/manifest.json b/manifest.json index c6d6ded..6fbe197 100644 --- a/manifest.json +++ b/manifest.json @@ -1,5 +1,5 @@ { - "name": "My Bookmarks Extension", + "name": "My Bookmarks", "version": "1.0", "description": "Save and display bookmarks", "manifest_version": 3, diff --git a/readme.md b/readme.md index f4ef957..61bb0e8 100644 --- a/readme.md +++ b/readme.md @@ -9,7 +9,7 @@ # 🙌 Welcome to BookMark ## Purpose: -To introduce an extension that can help users save all the links they want in one place. +An extension that can help users save all the links they want in one place. ## Features: @@ -26,7 +26,7 @@ To introduce an extension that can help users save all the links they want in on - That's it! You have now created a new bookmark using BookMark🔖.
-

Free-Hit can be used by anyone, from casual internet users to professionals!

+

BookMark🔖 can be used by anyone

# 🎥 Project Overview @@ -36,29 +36,33 @@ To introduce an extension that can help users save all the links they want in on We welcome you to join us! -- **BookMarK** is an open-source project, and we are excited to hear your thoughts and ideas. +- **BookMark🔖** is an open-source project, and we are excited to hear your thoughts and ideas. - Fork this repository,add your contributions and submit a PR. - Found a bug? Accessibility issue? Or do you want to add a new feature? Then go right ahead and create an issue. # 🛠️ Tech Stack This project uses:

-![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) -![PNPM](https://img.shields.io/badge/pnpm-%2320232a.svg?style=for-the-badge&logo=pnpm&logoColor=%2361DAFB) -![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white) -![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white) +![HTML](https://img.shields.io/badge/🗽_html-%23000000.svg?style=for-the-badge&logo=html&logoColor=%2361DAFB) +![Css](https://img.shields.io/badge/🎨_css-%23000000.svg?style=for-the-badge&logo=css&logoColor=%2361DAFB) +![JavaScript](https://img.shields.io/badge/javascript-%23000000.svg?style=for-the-badge&logo=javascript&logoColor=%FFFF00) + ## Prerequisites Before installation, you need to have installed/knowledge of the following:

-![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white) +![NodeJS](https://img.shields.io/badge/chrome_Browser-6DA55F?style=for-the-badge&logo=chrome&logoColor=white) ![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white) +## Using/Installation of the extention +Follow the link to contribute to **BookMark🔖** - [INSTALLATION.md](./INSTALLATION.md) + + ## 🤝 Contributing -Follow the link to contribute to Free-Hit - [CONTRIBUTING.md](./CONTRIBUTING.md) +Follow the link to contribute to **BookMark🔖** - [CONTRIBUTING.md](./CONTRIBUTING.md) ## ✨ Contributors