From 5662b25e9eec9787365249dd8870663508678285 Mon Sep 17 00:00:00 2001
From: "Federico \"Edo\" Granata" <3602209+Edo78@users.noreply.github.com>
Date: Fri, 21 Jan 2022 16:25:07 +0100
Subject: [PATCH] update the README

---
 README.md | 14 ++++----------
 1 file changed, 4 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 5c685a8..1464fe1 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,6 @@
 # Obsidian KOReader Plugin
 
-**Rigth now this is just an ugly PoC**
-
-## Test the plugin
-I **STRONGLY** suggest to test this plugin in a disposable vault to avoid any mess.
-
-This is a pre-release version so if you want to test/help you should follow the step for developing a plugin
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Enable plugin in settings window.
+Sync [KOReader][1] notes in your [Obsidian][2] vault. The KOReader device must be connected to the device running obsidian to let the plugin scan through it's metadata.
 
 ## Configuration
 There ara two settings:
@@ -24,3 +15,6 @@ Create an issue if something didn't work as expected.
 ## Known Issues
 - the name of the note is set to the note as written is koreader so it can be too long
 - editing the note in koreader will create a new note in obsidian but the old one will not be removed
+
+[1]: https://koreader.rocks/
+[2]: https://obsidian.md
\ No newline at end of file