-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Your Name
committed
Apr 22, 2023
1 parent
e65f662
commit 3b08f9d
Showing
4 changed files
with
246 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: <br><br> | ||
|  | ||
|  | ||
|  | ||
|
|
||
|
|
||
|
|
||
| # Prerequisites | ||
|
|
||
| ### Before installation, you need to have installed/knowledge of the following: | ||
|  | ||
|  | ||
|
|
||
| <br> | ||
|
|
||
| ## This Extension is not yet published on the Chrome Web Store <br><br> | ||
|
|
||
| # **To Test/contribute to this extension, follow the steps below:**<br><br> | ||
|
|
||
|
|
||
| ### 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: | ||
|
|
||
| <a href="https://ibb.co/YZhMnNY"><img src="https://i.ibb.co/ZmxP4ft/Screenshot-from-2023-04-21-11-09-52.png" alt="Screenshot-from-2023-04-21-11-09-52" border="0"></a> | ||
|
|
||
| 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 | ||
|
|
||
| <a href="https://ibb.co/4jJgb6r"><img src="https://i.ibb.co/Q6XjW2w/Screenshot-from-2023-04-21-11-09-08.png" alt="Screenshot-from-2023-04-21-11-09-08" border="0"></a> | ||
|
|
||
| 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. | ||
|
|
||
| <a href="https://ibb.co/Wtwfv9j"><img src="https://i.ibb.co/YZMhB9w/Screenshot-from-2023-04-21-11-08-30.png" alt="Screenshot-from-2023-04-21-11-08-30" border="0"></a> | ||
|
|
||
| 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. | ||
|
|
||
| <a href="https://ibb.co/XzS1v61"><img src="https://i.ibb.co/dQGFzXF/Screenshot-from-2023-04-22-13-47-03.png" alt="Screenshot-from-2023-04-22-13-47-03" border="0"></a> | ||
|
|
||
| ## 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: | ||
|
|
||
| <a href="https://ibb.co/Gv4WXyp"><img src="https://i.ibb.co/hRJBkb9/Screenshot-from-2023-04-22-13-51-10.png" alt="Screenshot-from-2023-04-22-13-51-10" border="0"></a> | ||
| <br><br> | ||
| <a href="https://ibb.co/1sgtwqs"><img src="https://i.ibb.co/SQj49nQ/Screenshot-from-2023-04-22-13-51-56.png" alt="Screenshot-from-2023-04-22-13-51-56" border="0"></a> | ||
|
|
||
| - 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. | ||
|
|
||
| <a href="https://ibb.co/V3tPnq0"><img src="https://i.ibb.co/6Nmf9Wc/Screenshot-from-2023-04-22-13-52-23.png" alt="Screenshot-from-2023-04-22-13-52-23" border="0"></a> | ||
|
|
||
| - You will see the bookmark on the extensions space. | ||
| - You can click on the title to visit the website. | ||
|
|
||
| <a href="https://ibb.co/cDy5Hs8"><img src="https://i.ibb.co/KF5Zk8s/Screenshot-from-2023-04-22-13-57-14.png" alt="Screenshot-from-2023-04-22-13-57-14" border="0"></a> | ||
|
|
||
| ### 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. | ||
|
|
||
| <a href="https://ibb.co/f0WJQBY"><img src="https://i.ibb.co/PCykt3Z/Screenshot-from-2023-04-22-13-54-15.png" alt="Screenshot-from-2023-04-22-13-54-15" border="0"></a> | ||
| <a href="https://ibb.co/vj6W52X"><img src="https://i.ibb.co/qr38GbJ/Screenshot-from-2023-04-22-13-54-31.png" alt="Screenshot-from-2023-04-22-13-54-31" border="0"></a><br><br> | ||
|
|
||
| # 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 <your-name> | ||
| ``` | ||
|
|
||
| > 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 | ||
|
|
||
| <a href="https://github.com/JasonDsouza212/BookMark/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=JasonDsouza212/BookMark" /> | ||
| </a> | ||
|
|
||
| <br> | ||
| <div align="center"> | ||
| <h3>Show some ❤️ by starring this awesome repository!</h3> | ||
| </div> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: <br><br> | ||
|  | ||
|  | ||
|  | ||
|
|
||
|
|
||
|
|
||
| # Prerequisites | ||
|
|
||
| ### Before installation, you need to have installed/knowledge of the following: | ||
|  | ||
|
|
||
| <br> | ||
|
|
||
| ## This Extension is not yet published on the Chrome Web Store <br><br> | ||
|
|
||
| # **To install this extension for personal use, follow the steps below:**<br><br> | ||
|
|
||
|
|
||
| ### 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: | ||
|
|
||
| <a href="https://ibb.co/YZhMnNY"><img src="https://i.ibb.co/ZmxP4ft/Screenshot-from-2023-04-21-11-09-52.png" alt="Screenshot-from-2023-04-21-11-09-52" border="0"></a> | ||
|
|
||
| 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 | ||
|
|
||
| <a href="https://ibb.co/4jJgb6r"><img src="https://i.ibb.co/Q6XjW2w/Screenshot-from-2023-04-21-11-09-08.png" alt="Screenshot-from-2023-04-21-11-09-08" border="0"></a> | ||
|
|
||
| 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. | ||
|
|
||
| <a href="https://ibb.co/Wtwfv9j"><img src="https://i.ibb.co/YZMhB9w/Screenshot-from-2023-04-21-11-08-30.png" alt="Screenshot-from-2023-04-21-11-08-30" border="0"></a> | ||
|
|
||
| 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. | ||
|
|
||
| <a href="https://ibb.co/XzS1v61"><img src="https://i.ibb.co/dQGFzXF/Screenshot-from-2023-04-22-13-47-03.png" alt="Screenshot-from-2023-04-22-13-47-03" border="0"></a> | ||
|
|
||
| ## 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: | ||
|
|
||
| <a href="https://ibb.co/Gv4WXyp"><img src="https://i.ibb.co/hRJBkb9/Screenshot-from-2023-04-22-13-51-10.png" alt="Screenshot-from-2023-04-22-13-51-10" border="0"></a> | ||
| <br><br> | ||
| <a href="https://ibb.co/1sgtwqs"><img src="https://i.ibb.co/SQj49nQ/Screenshot-from-2023-04-22-13-51-56.png" alt="Screenshot-from-2023-04-22-13-51-56" border="0"></a> | ||
|
|
||
| - 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. | ||
|
|
||
| <a href="https://ibb.co/V3tPnq0"><img src="https://i.ibb.co/6Nmf9Wc/Screenshot-from-2023-04-22-13-52-23.png" alt="Screenshot-from-2023-04-22-13-52-23" border="0"></a> | ||
|
|
||
| - You will see the bookmark on the extensions space. | ||
| - You can click on the title to visit the website. | ||
|
|
||
| <a href="https://ibb.co/cDy5Hs8"><img src="https://i.ibb.co/KF5Zk8s/Screenshot-from-2023-04-22-13-57-14.png" alt="Screenshot-from-2023-04-22-13-57-14" border="0"></a> | ||
|
|
||
| ### 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. | ||
|
|
||
| <a href="https://ibb.co/f0WJQBY"><img src="https://i.ibb.co/PCykt3Z/Screenshot-from-2023-04-22-13-54-15.png" alt="Screenshot-from-2023-04-22-13-54-15" border="0"></a> | ||
| <a href="https://ibb.co/vj6W52X"><img src="https://i.ibb.co/qr38GbJ/Screenshot-from-2023-04-22-13-54-31.png" alt="Screenshot-from-2023-04-22-13-54-31" border="0"></a> | ||
|
|
||
| ## ✨ Contributors | ||
|
|
||
| <a href="https://github.com/JasonDsouza212/BookMark/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=JasonDsouza212/BookMark" /> | ||
| </a> | ||
|
|
||
| <br> | ||
| <div align="center"> | ||
| <h3>Show some ❤️ by starring this awesome repository!</h3> | ||
| </div> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters