Annotated-Link

Professional Link Sharing and Annotation Extension for Browser .To share link with text highlited with different colors, comment's attached to the highlight and other stuff for proper link sharing. It is designed to make collabrations easier between the developers and users.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

"It is an easy-to-use extension or plugin for your browser. To use it, simply install it and choose what you want to learn. Then let it do its thing."

(back to top)

Built With

It is built with javascript wih DOMJs

• 

(back to top)

Getting Started

So If want to use it for yourself then here is how.

Prerequisites

You must obviously have a internet-browsers like chrome,firefox,brave ,opera etc...

Installation

Now the packages installation and file setup part.Follow the step below and you should be goto go.

1. Clone the repo

   git clone https://github.com/leyuskckiran1510/Annotated-Link.git
   cd ./Annotated-Link

   I assume you are in the code folder after this till to very end.

2. Now Install the Extension To Your Browser.
   a) If You have Chromium based browsers like
   

   Google Chrome
   Microsoft Edge
   Brave
   Opera
   Vivaldi
   Epic Privacy Browser
   SRWare Iron
   Blisk
   Comodo Dragon
   Yandex Browser 
   

   a.1)Follow these steps

   Open Up Your Browser.
   Open up any of these link according to your browser name.
   
           Google Chrome/Brave:    chrome://extensions/
           Microsoft Edge:         edge://extensions/
           Opera:                  opera://extensions/
           Vivaldi:                vivaldi://extensions/
           For any browers:-       about://extensions/
   
   If you don't see your browser name then paste chrome's url other chromium based browser works with chrome url
   
          
   

   a.2) Click on Load UnPack or Import:
   a.3) Now navigate towards the path of step 1
   a.3) Select Folder with name Extension.

   
   b) If You have fireFox Based Browsers like
   

   Mozilla Firefox
   Waterfox
   Pale Moon
   Basilisk
   Seamonkey
   IceCat
   

   
   b.1) Follow these steps:-

   Open Up Your Browser.
   Open This Link:-
               about:addons
   

   
   b.2) On left hand side bar select Extension Tab
   b.3) Click On Gear/Setting Icon
   b.4) Select Load From File option.
   b.5)Now navigate towards the path of step 1
   b.6)Select Folder with name Extension.

(back to top)

Usage

Professional Link Sharing and Annotation Extension for Browser which makes easier to share link with text highlited , commented and other stuff for proper link sharing.
If you want to share a link for a documentations but you want the others to look exactly where you want them to read. Normally many websites adapte to selection with id (#id) methods but sometime these paragraphs may be huge. So in these cases you can use it to highlight the particular text, color it, resize the selected text, add comment to the selected text and many more in comming updates.

For more examples, please refer to the Documentation.

A Example or simple usecase video may be uploaded to youtube if uploaded then you can click this link Video

#UseCase and Images will be published after the project is completed.

(back to top)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU license. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: Click ME

(back to top)

Acknowledgments

Will fill letter when project gets started
Also Thanks to @othneildrew for providing these readme template.

(back to top)