From 0de1a1c9775c526a3cae9975678725a5c9dca42a Mon Sep 17 00:00:00 2001 From: Kyle Bowman Date: Sat, 11 Jan 2025 15:42:36 -0500 Subject: [PATCH] add content to README --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index e69de29..1dc34db 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,40 @@ +# Overview + +Nom is the cartoonish sound of eating. And, it's easy to type. So it seems like +a decent name for a command line tool for managing your feeds. + +## Managing feeds? So it's a feed reader? + +No. Not really. A feed reader normally has a rendering component to it. But +rendering is hard and everyone already has a broweser. Why spend a lot a ton +of effort trying to recreate a browser? You'll inevitably end up with a +supbar experience. + +Instead, we focus on the non-rendering parts of a feed reader: + +* Maintaining a list of feeds +* Fetching updates +* Listing entry data +* Tracking which entries you have and haven't read + +All this can be done pretty simply at the command line and with text. That +simplicity comes with a few perks: + +* It works offline. (Of course, you need to be connected to fetch updates.) +* Your data is easy to read and exclusively yours. +* It's easy to sync across devices using your favorite file sync tools. +* You can integrate it with other command line tools. + +Yeah, this is basically the Unix philosophy. If you're into that kind of thing, +you'll enjoy this tool. + +## Usage + +1. There are commands that operate on feeds. They start with `nom feed`. +2. There are commands that operatre on entries. They start with `nom entry`. + +* `nom entry show` shows all the entries from feeds in your feed list that + you have not viewed. +* `nom feed fetch` fetches updates from all your feeds +* `nom entry show | xargs -n1 xdg-open` opens all your unread entries in your + default web browser. -- 2.39.5