astro

commit b2868b2062478c30074d4b96bdee481b8178f073
parent 3871d15df415a08383f8e47cad4b53838b4de64d
Author: Brian Mayer <bleemayer@gmail.com>
Date:   Mon,  5 Jul 2021 02:19:10 -0300

Update README.md
Diffstat:
M
README.md
 | 
23
++++++++++++++++++++++-

1 file changed, 22 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
 # astro
-A Gemini web browser using shell script
+
+> A Gemini web browser using shell script
+
+
+## Installing
+
+Move the file *astro* to a folder in your PATH variable.
+
+
+## Using
+
+Start browsing by running astro with an optional URL:
+
+`astro gemini://rawtext.club:1965/~sloum/spacewalk.gmi`
+
+you can omit the protocol and port:
+
+`astro rawtext.club/~sloum/spacewalk.gmi`
+
+no arguments takes you to *gemini.circumlunar.space*:
+
+`astro`