diff options
| author | untir_l <87096069+untir-l@users.noreply.github.com> | 2022-05-29 12:10:59 +0000 |
|---|---|---|
| committer | untir_l <87096069+untir-l@users.noreply.github.com> | 2022-05-29 12:10:59 +0000 |
| commit | ce707fd07043b02399c5753acc613662aa0c91a8 (patch) | |
| tree | 2c23d84eb46e7140d2440c62e1c1ce241581f2c2 | |
| parent | c153bd9ad95b156b11e4d631d3bd5af0a8225ba9 (diff) | |
| download | userscripts-ce707fd07043b02399c5753acc613662aa0c91a8.tar userscripts-ce707fd07043b02399c5753acc613662aa0c91a8.tar.gz userscripts-ce707fd07043b02399c5753acc613662aa0c91a8.zip | |
Add top level README.md, other changes to documentation
| -rw-r--r-- | ExplainXKCD-Quick-Link/README.md | 8 | ||||
| -rw-r--r-- | README.md | 5 | ||||
| -rw-r--r-- | Show-XKCD-Date/README.md | 8 |
3 files changed, 11 insertions, 10 deletions
diff --git a/ExplainXKCD-Quick-Link/README.md b/ExplainXKCD-Quick-Link/README.md index 26606ee..f816eea 100644 --- a/ExplainXKCD-Quick-Link/README.md +++ b/ExplainXKCD-Quick-Link/README.md @@ -10,12 +10,10 @@ 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). +Load `explainxkcd_quick_link.user.js` into your userscript manager of choice (it is tested with Greasemonkey). -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. +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 Greasemonkey or Tampermonkey to use userscripts. -## Copyright and technical info +## Copyright 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b0cbfc6 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# Arjun Satarkar's Userscripts + +Userscripts are similar to browser extensions - JavaScript code executed on certain sites in order to enhance the experience in some way. You need a userscript manager browser extension, like [Greasemonkey](https://www.greasespot.net/) or [Tampermonkey](https://www.tampermonkey.net/), to use them. + +These are userscripts I've created, primarily for my own use. They're generally small, simple tweaks to particular sites. diff --git a/Show-XKCD-Date/README.md b/Show-XKCD-Date/README.md index c9d629f..289b874 100644 --- a/Show-XKCD-Date/README.md +++ b/Show-XKCD-Date/README.md @@ -8,12 +8,10 @@ Here is a screenshot of the addition, highlighted: ## Usage -Load `show_xkcd_date.user.js` into your userscript manager of choice (it is tested with Tampermonkey). +Load `show_xkcd_date.user.js` into your userscript manager of choice (it is tested with Greasemonkey). -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. +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 Greasemonkey or Tampermonkey to use userscripts. -## Copyright and technical info +## Copyright 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. |