aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b7c2ca8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Gopher plugin for Dillo
+
+This plugin allows Dillo to open pages using the [Gopher
+protocol](https://en.wikipedia.org/wiki/Gopher_(protocol)).
+
+![Screenshot of Dillo opening a Gopher site](screenshot.png)
+
+To install it use:
+
+```sh
+$ make install
+```
+
+Then open a gopher page using the `gopher:` protocol:
+
+```sh
+$ dillo gopher://gopher.floodgap.com:70
+```
+
+Created by [Charles E. Lehner](https://celehner.com/) along with other
+[Dillo plugins](https://celehner.com/projects.html#dillo-plugins).