From aa2349a9ad6b52b779cae86eb1ad640d378480a6 Mon Sep 17 00:00:00 2001
From: FliegendeWurst <2012gdwu+github@posteo.de>
Date: Fri, 23 Apr 2021 10:56:44 +0200
Subject: [PATCH] Create readme

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..267da43
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+## Usage
+
+Zip the contents of the `notes` directory into a .zip file and import it into Trilium Notes (right-click into the tree sidebar -> Import).
+
+Acquire a bot token from Telegram and save it in the environment variable `TELEGRAM_BOT_TOKEN`.  
+Set `TRILIUM_HOST` to the `IP:port` of your sync server.  
+Set `TRILIUM_USER` and `TRILIUM_PASSWORD`.  
+Set `TELEGRAM_USER_ID` to your own Telegram User ID.
+
+Then simply run the program: `cargo run --release`.