Add README

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..176df12
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# rss - command-line RSS feed manipulation
+
+`rss` is like [`jq`](https://jqlang.github.io/jq/) for RSS files. A simple tool to fetch, filter, and extract information from RSS feeds.
+
+As an example, here is how to generate a summary of all posts submitted to [lobste.rs](https://lobste.rs) yersterday:
+
+```
+$ rss fetch https://lobste.rs/rss | rss filter --date $(date -d "-1 day" "+%Y-%m-%d") | rss render template.tera
+- "6.33 times faster than C - part one": https://owen.cafe/posts/six-times-faster-than-c/
+- "TySON: TypeScript Object Notation. Use TS as an embeddable config language": https://github.com/jetpack-io/tyson
+- "Learning to learn Rust": https://blog.danieljanus.pl/2023/07/06/learning-to-learn-rust/
+- "How do you use AI development tools?": https://lobste.rs/s/dqz1uk/how_do_you_use_ai_development_tools
+- "I want XAES-256-GCM/11": https://words.filippo.io/dispatches/xaes-256-gcm-11/
+- "Oils Is Exterior-First (Code, Text, and Structured Data)": https://www.oilshell.org/blog/2023/06/ysh-design.html
+- "The Many Ways that Digital Minds Can Know": https://moultano.wordpress.com/2023/06/28/the-many-ways-that-digital-minds-can-know/
+- "Sierra Creative Interpreter ??? Scripts": https://www.benshoof.org/blog/sci-scripts
+- "Observability Driven CI": https://andydote.co.uk/2023/07/06/observability-driven-ci/
+- "Souffl??: A Datalog Synthesis Tool for Static Analysis": https://souffle-lang.github.io/docs.html
+- "The case against self-closing tags in HTML": https://jakearchibald.com/2023/against-self-closing-tags-in-html/
+- "Be Open to Black: A Digital Design Tip": https://toast.al/posts/visuallayout/2023-07-06_be-open-to-black
+- "Tweaking Emacs for Ruby Development": https://johnhame.link/posts/tweaking-emacs-for-ruby-development-in-2023/
+- "Simulation Testing For Liveness": https://tigerbeetle.com/blog/2023-07-06-simulation-testing-for-liveness/
+
+$ cat template.tera
+{% for item in items -%}
+- "{{ item.title }}": {{ item.link }}
+{% endfor %}
+```
\ No newline at end of file