From 90feff2bfcbdb5586a459c2350a4172a4423668e Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Wed, 13 Mar 2024 22:06:46 +0100 Subject: ci: deploy the built Docker image MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miquel Sabaté Solà --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ef40c7c..412ba86 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,20 @@ > > — P. Ovidi Nasonis - Fasti 3.833-834 -This is a small application in order to keep track of books, articles, papers, -etc.; that you might have and need to know where they are, reference it on a -paper, etc. To sum things up, it's a way to keep your bibliography under -control. - -## Basic usage - -To do. +This is a simple application that keeps track of all your sources (i.e. books, +papers, articles). With this information at hand you can: + +- Add comments and notes to any source to keep track of what you found more + relevant from it. +- Tag sources and comments in the way you wish. +- Save searches that match on a user-defined tag, or a certain string from any + of your comments. +- Export searches into CSV or TeX so it can be used for building up bibliography + sections on a paper you might be working on. + +The *workflow* revolves around the idea of being able to tag sources and +comments with tags that you might want to define, and then being able to list +sources with searches based on these tags. ## Deployment -- cgit v1.2.3