Skip to content

Commit

Permalink
Update README.md (#3)
Browse files Browse the repository at this point in the history
* Update README.md 📖
  • Loading branch information
smashedr authored Oct 21, 2023
1 parent 1491079 commit ee1e483
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 18 deletions.
25 changes: 9 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,20 @@

Modern Chrome and Firefox Addon to extract all links from a web page with optional filters.

* Firefox: https://addons.mozilla.org/addon/link-extractor
* Chrome: https://chrome.google.com/webstore/detail/link-extractor/ifefifghpkllfibejafbakmflidjcjfp

# Table of Contents

* [Overview](#overview)
* [Features](#features)
* [Development](#development)
* [Configuration](#configuration)
* [Development](#development)
- [Chrome Setup](#chrome-setup)
- [Firefox Setup](#firefox-setup)
- [Building](#building)

# Overview

Easily extract links and/or domains from any site with an optional filter including automatic dark/light mode.

* Firefox: https://addons.mozilla.org/addon/link-extractor
* Chrome: https://chrome.google.com/webstore/detail/link-extractor/ifefifghpkllfibejafbakmflidjcjfp

# Features

* Extract all Links and/or Domains
Expand All @@ -40,7 +37,11 @@ You can optionally pin the Addon by clicking the `Puzzle Piece`, then;

# Development

Instructions to run from source, build locally, or test/develop the extension.
The extension is automatically built on every release which uploads the artifacts to that release.
See [build.yaml](.github%2Fworkflows%2Fbuild.yaml) for more information.

To build locally, clone the repository then run `npm install`.
You can then run the addon from the [src](src) directory as normal.

## Chrome Setup

Expand All @@ -61,11 +62,3 @@ Instructions to run from source, build locally, or test/develop the extension.
1. Open `about:config` search for `xpinstall.signatures.required` and set to `false`.
1. Open `about:addons` and drag the zip file to the page or choose Install from File from the Settings wheel.
1. You may also load temporary from: `about:debugging#/runtime/this-firefox`

## Building

The extension is automatically built on every release which uploads the artifacts to that release.
See [build.yaml](.github%2Fworkflows%2Fbuild.yaml) for more information.

To build locally, clone the repository then run `npm install`.
You can then run the addon from the [src](src) directory as normal.
2 changes: 1 addition & 1 deletion src/html/options.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h1 class="text-center">Link Extractor Options</h1>
</div>
<div class="text-center">
<a class="icon-link icon-link-hover" style="--bs-link-hover-color-rgb: 25, 135, 84;" target="_blank" rel="noopener"
href="https://github.com/cssnr/link-extractor#table-of-contents">Get Help</a>
href="https://github.com/cssnr/link-extractor#link-extractor">Get Help</a>
|
<a class="icon-link icon-link-hover" style="--bs-link-hover-color-rgb: 25, 135, 84;" target="_blank" rel="noopener"
href="https://github.com/cssnr/link-extractor/discussions/new?category=feature-requests">Request Feature</a>
Expand Down
2 changes: 1 addition & 1 deletion src/html/popup.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<label for="filter-input" class="visually-hidden"></label>
<input id="filter-input" class="form-control" type="text" placeholder="Filter">
</form>
<button id="btn-default" class="btn btn-info btn-sm popup-click" type="button">Links w/ Default Filter</button>
<!-- <button id="btn-default" class="btn btn-info btn-sm popup-click" type="button">Links w/ Default Filter</button>-->
<button id="btn-domains" class="btn btn-primary btn-sm popup-click" type="button">Only Domains</button>
<button id="btn-options" class="btn btn-outline-warning btn-sm popup-click" type="button" data-href="html/options.html">Open Options</button>
<!-- <button id="btn-about" class="btn btn-outline-warning btn-sm popup-click" type="button">Open Homepage</button>-->
Expand Down

0 comments on commit ee1e483

Please sign in to comment.