aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan <me@jordan.im>2021-02-18 15:09:07 -0700
committerJordan <me@jordan.im>2021-02-18 15:09:07 -0700
commit09b7e00a9db58e1f4b08581a6b0df4d8aaed1c47 (patch)
treea57548f815b7dc10ec0a88d05c68d1f97a998589
parente04cae5a0ab32ba78db7f0d24780e5f350f3da54 (diff)
downloadcrane-09b7e00a9db58e1f4b08581a6b0df4d8aaed1c47.tar.gz
crane-09b7e00a9db58e1f4b08581a6b0df4d8aaed1c47.zip
readme
-rw-r--r--README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index d06e6de..e07dac9 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
# Crane
-Crane is a minimal self-hosted research literature organizational web service
-with support for paper download and metadata retrieval.
+Crane is a literature download and organization web service with support for
+paper download and metadata retrieval.
-No databases or app-proprietary formats are used. Papers are categorized by the
-directories in which they're stored, and XML metadata is retrieved from the
-[doi.org](https://www.doi.org/) API and written alongside each paper for which
-its DOI is known.
+Goals of the project are to be minimal, support data portability (no databases
+or app-proprietary formats), and secure. Paper "categories" are simply
+directories created on the filesystem, and paper metadata taken directly from
+the [doi.org](https://www.doi.org/) API and written verbatim.
-![admin](screenshots/admin.png)
+A screenshot of the interface can be [found here](screenshots/admin.png).
## Installation