aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2017-12-07 22:11:27 +0100
committerTeddy Wing2017-12-07 22:11:27 +0100
commit6b3fdc1b00dc2fa35dc39323c80f97bd1dbe75dc (patch)
treeb8e61d7bc5db2807b78dc5f77893876e9c541413
parent5565ee114e3efb4837627555d3db66ffea317be5 (diff)
downloadGitHub-Open-All-Outdated-Comments-6b3fdc1b00dc2fa35dc39323c80f97bd1dbe75dc.tar.bz2
Add README
Describe the script, and include installation instructions and license information.
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..76d37c8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+GitHub Open All Outdated Comments
+=================================
+
+A [Greasemonkey][1] user script that expands all hidden pull request comments.
+Changes to a line cause comments to collapse. If any replies were added to a
+thread, these will be hidden from view. This script makes it easier to see all
+replies by expanding everything by default.
+
+
+## Install
+Ensure Greasemonkey is installed and activated. Open the [raw script][2] and
+click “Install” in the resulting dialog. A [more detailed explanation][3] is
+available on the Greasemonkey wiki.
+
+
+## License
+Copyright © 2017 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).
+
+
+[1]: https://www.greasespot.net/
+[2]: https://raw.githubusercontent.com/teddywing/github-open-all-outdated-comments/master/github-open-all-outdated-comments.user.js
+[3]: https://wiki.greasespot.net/Greasemonkey_Manual:Installing_Scripts