Browse Source

added readme covering project's goal

azivner 6 years ago
parent
commit
b1ca15e635
1 changed files with 11 additions and 2 deletions
  1. 11 2
      README.md

+ 11 - 2
README.md

@@ -1,2 +1,11 @@
-# trilium-sender
-Simple android application for sending images and notes to Trilium
+# Trilium Sender
+Trilium Sender is a simple Android application for sending images and notes to [Trilium](https://github.com/zadam/trilium).
+
+It's not a full Android port of Trilium and it's not meant to be one - instead it's supposed to cover only following use cases:
+
+* write plain text notes and send them to Trilium
+* send images (photos) to Trilium
+
+Specifically, this app doesn't support reading or modifying existing notes, it's "write-only".
+
+Both notes and images are saved as new notes under "day note" in Trilium server.