From 2c813e7f6ba5c2b6abba6ad7f5f22bcea6daeed0 Mon Sep 17 00:00:00 2001 From: Bauke Date: Wed, 5 Oct 2022 13:11:11 +0200 Subject: [PATCH] Create the readme. --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc34939 --- /dev/null +++ b/README.md @@ -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.