From dc1cd468154ce3fe1ae5d71c576b0043fb3adcc0 Mon Sep 17 00:00:00 2001 From: Dennis Date: Fri, 30 Aug 2024 14:46:15 +0200 Subject: [PATCH] Updates documentation --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 43f960b..582f741 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # freed -A unique feed aggregator and bookmarking service that tries to free you from too much content. + +A unique feed aggregator and bookmarking service that tries to free you from too much content. Currently only a CLI program, but I plan to add a web server and frontend in the future. In active development. + +## Installation + +The easiest way to install the program is by using `go install`: + +```sh +go install ... +``` + +## Usage + +- [ ] Document usage after commands are set up