aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuchen Pei <hi@ypei.me>2022-10-21 12:06:35 +1100
committerYuchen Pei <hi@ypei.me>2022-10-21 12:06:35 +1100
commit91764c44b9ffcdea93f522375daa3b03bd543e27 (patch)
treecdc0eb1af97e05b7efcf52bd59fc20225032b982
parent8373015f753497f08c3c7158a4bd2323ea007974 (diff)
updated readme
-rw-r--r--README.org21
1 files changed, 14 insertions, 7 deletions
diff --git a/README.org b/README.org
index 4057715..fca122d 100644
--- a/README.org
+++ b/README.org
@@ -2,24 +2,25 @@
* Overview
-Luwak mode is a simple Emacs GET-only and text-only web browser, based
-on ~lynx -dump~.
+luwak mode is a simple Emacs web browser based on ~lynx -dump~. It is
+currently text-only and GET-only.
Features:
+- Asynchronous loading
- Some usual browser features: open, reload, search with a search
engine, follow links, go forward / backward in history, copy url of
the current page or link at point
- Completion from persistent history in prompt to open a url
-- Write the dump of the current page to a file
-- Render a lynx dump in the luwak mode
+- Multiple ways of rendering links: numbered, forward-sexp or hide
+ altogether
+- Quickly open a link on the page with completion for url / link id
- imenu support, from all unindented strings (which look like
headings)
- Support of storing and capturing for org mode, guessing the title
(first imenu item)
-- Multiple ways of rendering links: numbered, forward-sexp, hide
- altogether
-- Quickly open a link on the page with completion for url / link id
+- Write the dump of the current page to a file
+- Render a buffer containing a lynx dump in the luwak mode
- Browse with or without torsocks
* Install and use
@@ -45,6 +46,12 @@ There are three entry points:
lynx dump -> feline excretion -> Kopi Luwak
+* TODOs
+
+- Multiple search engines
+- Support for images
+- Support for POST
+
* Contact and license
luwak is maintained by Yuchen Pei (id@ypei.org). It is covered by [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU