Skip to content

Commit

Permalink
update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Edo78 committed Jan 21, 2022
1 parent 4983ac4 commit 5662b25
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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

0 comments on commit 5662b25

Please sign in to comment.