added some fanciness to the README

This commit is contained in:
Ell 2022-03-21 14:52:55 +01:00
parent 0251931cbd
commit c90f4ac55d
2 changed files with 5 additions and 4 deletions

View file

@ -1,12 +1,13 @@
# ObsidianKeep
# Obsidian Keep
An Obsidian plugin that displays Google Keep in the app.
![A screenshot of the Obsidian Keep plugin in action](screenshot.png)
Since Google Keep doesn't allow the use of iframes, this plugin gets creative by adding a [BrowserView](https://www.electronjs.org/docs/latest/api/browser-view) for the Google Keep view. However, since they render on top of everything else, the view has to be hidden whenever a modal or menu is open. It's a compromise.
When the official [Google Keep API](https://developers.google.com/keep) is farther along and has an official JavaScript API, this plugin will start using that instead, probably.
The plan is that, once the official [Google Keep API](https://developers.google.com/keep) is farther along and has an official JavaScript API, this plugin will start using that instead.
## Installation
This plugin isn't on the official list of community plugins, so you'll have to install it manually.
## Manual Installation
- Go to the [latest release](https://github.com/Ellpeck/ObsidianKeep/releases) here on GitHub
- Download `obsidian-keep.zip`
- Extract `obsidian-keep.zip` into your vault's `.obsidian/plugins` folder so that the resulting `obsidian-keep` folder contains the `main.js` and `manifest.json` files

BIN
screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 167 KiB