Initial commit

1 files changed, 21 insertions, 0 deletions

diff --git a/ExplainXKCD-Quick-Link/README.md b/ExplainXKCD-Quick-Link/README.md
new file mode 100644
index 0000000..943cc00
--- /dev/null
+++ b/ExplainXKCD-Quick-Link/README.md
@@ -0,0 +1,21 @@
+# ExplainXKCD-Quick-Link
+
+A userscript for [xkcd](https://xkcd.com/), "a webcomic of romance, sarcasm, math, and language", which for each comic adds a link to the comic's [explain xkcd](https://www.explainxkcd.com/wiki/index.php/Main_Page) page.
+
+Here is a screenshot of the addition:
+
+<img src="https://github.com/untir-l/userscripts/blob/main/Explain-XKCD-Quick-Link/screenshot.png?raw=true" width="500">
+
+This will always go to the page for the specific comic you are viewing.
+
+## Usage
+
+Load `explainxkcd_quick_link.user.js` into your userscript manager of choice (it is tested with Tampermonkey).
+
+A userscript is a bit like a browser extension - it's a JavaScript file which is automatically executed on certain pages (in this case on xkcd) and improves them in some way. You will need an extension like Tampermonkey or Greasemonkey to use userscripts.
+
+## Copyright and technical info
+
+This userscript is copyright © 2021 Arjun Satarkar and licensed under the MIT License. See LICENSE.txt for the full text.
+
+Written in JavaScript to run as a TamperMonkey userscript. Code formatted using the XO style with ESLint.