Holllo/re-nav
Holllo
/
re-nav
1
Fork 0
Code Issues 1 Releases 4 Activity

Create the readme.

This commit is contained in:
Bauke 2022-10-05 13:11:11 +02:00
parent 64fed8ef87
commit 2c813e7f6b
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# Re ↩ Nav
> **Navigation redirects for the masses.**
## Installation
You can install Fangs through the stores linked above, [manually from a file] (see [the Releases page] for ZIP files) or [from source](#development).
[manually from a file]: https://support.mozilla.org/en-US/kb/find-and-install-add-ons-add-features-to-firefox#w_how-do-i-find-and-install-add-ons
[the Releases page]: https://git.bauke.xyz/Holllo/re-nav/releases
## Development
To build Re-Nav you will need [git](https://git-scm.com), [NodeJS](https://nodejs.org) and [pnpm](https://pnpm.io).
* Install the dependencies with `pnpm install`.
* Start a separate browser with `pnpm start`.
* Build the WebExtension for production with `pnpm build`.
* Test the code with `pnpm test`.
## License
Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Holllo/re-nav/src/branch/main/LICENSE) for more information.