readme

README.md

@@ -0,0 +1,45 @@
+Bebop
+=====
+
+Bebop is a [Gemini][gemini] browser for the terminal, focusing on practicality
+and speed. It is a personal project to learn how to use ncurses and try new
+ways to explore the Geminispace. It borrows some ideas from [Amfora][amfora],
+another great terminal browser, Vim for interactivity and tries to support mouse
+usage decently.
+
+[gemini]: https://gemini.circumlunar.space/
+[amfora]: https://github.com/makeworld-the-better-one/amfora
+
+If you are interested in Gemini and looking for a client, I recommend trying a
+graphical one like the excellent [Lagrange][lagrange] or [Kristall][kristall],
+or Amfora if you're feeling more at home in the terminal. Bebop won't attempt
+to support every feature other clients might have.
+
+[lagrange]: https://git.skyjake.fi/skyjake/lagrange
+[kristall]: https://kristall.random-projects.net/
+
+It passes the Conman's client test but not Egsam's for now.
+
+
+
+Features
+--------
+
+### What works
+
+- Basic browsing: scrolling, follow links, redirections, Web links.
+
+### What is planned
+
+- Handle more content types.
+- Great config options.
+- Identity management with temporary and managed certificates.
+- Buffers (or tabs if you prefer).
+- Home page.
+- Bookmarks.
+
+### What is not planned for now
+
+- 256-colors mode and themes.
+- Subscriptions. I have no need for them as I prefer to use a browser-agnostic
+    aggregator at the moment.