Add README

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..258dbeb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+GoDoc Links
+===========
+
+A user script to add links between [GoDoc][godoc], [pkg.go.dev], and
+[GitHub][github], to facilitate navigation between source and documentation.
+
+
+## Install
+Open the [raw script][raw_script] and click “Install” in the resulting dialog. A
+[more detailed explanation][greasemonkey_instructions] is available on the
+Greasemonkey wiki.
+
+
+## License
+Copyright © 2020 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).
+
+
+[godoc]: https://godoc.org/
+[pkg.go.dev]: https://pkg.go.dev/
+[github]: https://github.com/
+[raw_script]: https://raw.githubusercontent.com/teddywing/godoc-links/master/godoc-links.user.js
+[greasemonkey_instructions]: https://wiki.greasespot.net/Greasemonkey_Manual:Installing_Scripts