aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..074a4a5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Firefox Godocs.io Search
+========================
+
+A WebExtension that adds a search provider for [Godocs.io] so that shortcuts can
+be added for it.
+
+
+## Install
+This extension is unsigned. Refer to “What are my options if I want to install
+unsigned extensions in Firefox?” in
+https://wiki.mozilla.org/Add-ons/Extension_Signing#FAQ before attempting to
+install it.
+
+ $ cd '~/Library/Application Support/Firefox/Profiles/PROFILE_DIRECTORY/extensions'
+ $ git clone https://github.com/teddywing/firefox-godocs.io-search.git 'com.teddywing@godocs.io-search'
+
+Relaunch Firefox and open the Add-ons page (`about:addons`). Click the “Enable”
+button on Godocs.io Search’s row.
+
+
+## License
+Copyright © 2021 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).
+
+
+[Godocs.io]: https://godocs.io/