Skip to content

Commit

Permalink
Add installation steps to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NickyMateev committed Apr 23, 2020
1 parent 4e1330d commit 3f13ab4
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,22 @@ type of file with line numbering on GitHub.

<img src="promotional/file_focus_promotional.png" align="center">

## Installation

### FAQ
### Install extension through Chrome Web Store

Soon...

### Install the extension manually on your local machine

1. Download a [release](https://github.com/NickyMateev/Line-Clipper/releases) of your choice and unzip it **OR** clone this repository.
2. Navigate to *chrome://extensions* in your browser. You can also access this page by clicking on the Chrome menu on the top right side of the Omnibox, hovering over **More Tools** and selecting **Extensions**.
3. Check the box next to **Developer Mode**.
4. Click **Load Unpacked Extension** and select the directory where you downloaded and unpacked the plugin.

**Congratulations!** You can now use and play around with the plugin and its source.

## FAQ

Q: *Does this work only when traversing a GitHub project's file tree and looking at different files?*

Expand All @@ -73,3 +87,9 @@ Q: *Does it work for all GitHub installations or just the public *https://github

A: The extension works on all kinds of GitHub installations public/private as long as the domain contains
the word *github* in it.

## Notice

**LineClipper** (also known as **Line Clipper for GitHub** in the Chrome Web Store) is not endorsed by GitHub.

GitHub and Chrome are trademarks of their respective owners.
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Line Clipper for GitHub",
"version": "1.0",
"version": "1.0.0",
"description": "Effortlessly copy file paths with their respective line numbers when working on GitHub.",
"content_scripts": [{
"js": ["traverser.js"],
Expand Down

0 comments on commit 3f13ab4

Please sign in to comment.