From 959230d26a25665301cfac87f68a246ba0b66562 Mon Sep 17 00:00:00 2001 From: Josh McKinney Date: Thu, 9 Mar 2023 19:06:28 -0800 Subject: [PATCH] Add contributing section to readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 2db1603..c4fce86 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,22 @@ your own instance, then click follow there once the search loads. To use a server other than mastodon.social, go to the settings page and enter the server address including https://, omitting any trailing slash. +## Contributing + +To run the extension locally, install web-ext via npm: + +```shell +npm install -g web-ext +``` + +And then run with the following command + +```shell +web-ext run --source-dir ./src --target firefox-desktop --devtools --browser-console +``` + +This command is also found in the [just file](https://github.com/joshka/follow-mastodon-user-webextension/blob/main/.justfile) as `just run`. (See for more details). + ## Installation Install via