aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <msabate@suse.com>2024-03-13 22:06:46 +0100
committerMiquel Sabaté Solà <msabate@suse.com>2024-03-14 14:09:07 +0100
commit90feff2bfcbdb5586a459c2350a4172a4423668e (patch)
tree00217c407bcf0c1179355e1c6d052551a039e24e /README.md
parenta7791635aa98f012d35f97c3c5288494bbb28e38 (diff)
downloadoperum-90feff2bfcbdb5586a459c2350a4172a4423668e.tar.gz
operum-90feff2bfcbdb5586a459c2350a4172a4423668e.zip
ci: deploy the built Docker image
Signed-off-by: Miquel Sabaté Solà <msabate@suse.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 14 insertions, 8 deletions
diff --git a/README.md b/README.md
index ef40c7c..412ba86 100644
--- a/README.md
+++ b/README.md
@@ -9,14 +9,20 @@
>
> &mdash; 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