Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hazrpg authored Dec 31, 2021
1 parent dd9c9da commit 3b7888c
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# github-link-fixer
# GitHub Link Fixer
GitHub Link Fixer - The Download Friendly fix you didn't know you needed!

## About
Essentially what GitHub Link Fixer tries to do is create a script to make navigating GitHub easier and work more how you would expect the files to work. For example you can click on a link and it will take you to the file as per normal, but should you want that file you can right-click the link and then pick "Save As" and it will save the file in its raw format instead of giving you a HTML file.

Below is a preview of the experience, when you hover over the icons (e.g. the mouse or the eclamation icon) it explains everything to you:

![image](https://user-images.githubusercontent.com/115112/147837291-148daf45-2fed-449f-80a0-dc6f54ea74cf.png)


## How To Get Started

You need to have a script manager installed first for you to be able to use this. It is sure easy to get started on any browser:

#### Step 1: Install ScriptManager
* ![image](https://user-images.githubusercontent.com/115112/147837118-12812027-27df-4e70-9e93-b184be8f6fc0.png)
[Tampermonkey](https://addons.mozilla.org/firefox/addon/tampermonkey/) or [Greasemonkey](https://addons.mozilla.org/firefox/addon/greasemonkey/)
* ![image](https://user-images.githubusercontent.com/115112/147837134-43cbcdad-3b46-4a62-a151-7e6bfcd06789.png) [Tampermonkey](https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo)
* ![image](https://user-images.githubusercontent.com/115112/147837142-bfaab368-1c4c-4aa7-8b81-96f87489a2ce.png) [Tampermonkey](https://addons.opera.com/extensions/details/tampermonkey-beta/) or [Violentmonkey](https://addons.opera.com/extensions/details/violent-monkey/)
* ![image](https://user-images.githubusercontent.com/115112/147837157-4435bd2b-0274-40a3-8d97-5eb6488107b3.png) [Tampermonkey](https://www.tampermonkey.net/?ext=dhdg&browser=safari) or [NinjaKit](https://github.com/os0x/NinjaKit)
* ![image](https://user-images.githubusercontent.com/115112/147837164-fac6f824-ae98-41dc-b40d-d8f4de8bb24b.png) [Tampermonkey](https://www.microsoft.com/store/p/tampermonkey/9nblggh5162s)

> ##### Note: After installation (which requires restarting your browser), you are now ready to install userscripts.
#### Step 2: Install UserScript
* [Install](https://raw.githubusercontent.com/hazrpg/github-link-fixer/master/github-link-fixer.user.js) *from github.com*

> ##### Note: When you click on install you should see something like this:
> ![image](https://user-images.githubusercontent.com/115112/147837101-ee86722d-d7f3-4f5a-a176-aff955686a94.png)

0 comments on commit 3b7888c

Please sign in to comment.