aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2024-07-25 10:28:55 -0300
committerSilvio Rhatto <rhatto@riseup.net>2024-07-25 10:28:55 -0300
commit7b157a1a0e9e35ef8469faf9f5950df31a9a5d55 (patch)
tree3024f9a96100cd2d2612ab3e704b8dd1ccfdd953
parent61fd8edf2dabc0932ba491794048b0d46ae31051 (diff)
downloadfinder-7b157a1a0e9e35ef8469faf9f5950df31a9a5d55.tar.gz
finder-7b157a1a0e9e35ef8469faf9f5950df31a9a5d55.tar.bz2
Updates README and TODO
-rw-r--r--README.md14
-rw-r--r--TODO.md2
2 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7064459..0d05d3a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,19 @@
# Finder: CLI searcher and browser REPL
+## About
+
+Finder is a terminal-based searcher.
+
+It's like [ranger][], but with a search-like interface.
+
+It aims to replace the fatigue of frequently using [find][] + [grep][]
+combinations for finding files, but it's also intended for searching and
+browser other contents such as file lists, spreadsheets and remote queries.
+
+[ranger]: https://ranger.github.io
+[find]: https://en.wikipedia.org/wiki/Find_(Unix)
+[grep]: https://en.wikipedia.org/wiki/Grep
+
## Dependencies
* [Python][] 3+.
diff --git a/TODO.md b/TODO.md
index 8e10b23..3a5f0ac 100644
--- a/TODO.md
+++ b/TODO.md
@@ -26,7 +26,7 @@
* [ ] File lines (i.e, lines in a text file, including basic M3U support).
* [ ] CSV, TSV etc (i.e, values in lines in a text file).
* [ ] ODS, XLS etc.
-* [ ] Ana(r)chronofiles.
+* [ ] Tree-like structures like YAML files (example: Ana(r)chronofiles).
* [ ] RSS, Atom etc.
* [ ] Applications (in current working directory and on `$PATH`).
* [ ] Compressed files (find files and/or lines inside a compressed file).