From bfb6ad220929a88444022d726c645deb6ff7b025 Mon Sep 17 00:00:00 2001 From: Ellpeck Date: Tue, 22 Mar 2022 14:01:49 +0100 Subject: [PATCH] improve readme --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f8179a8..24b2752 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,17 @@ An Obsidian plugin that allows adding iframes with custom styling as editor tabs ![A screenshot of the plugin's settings](settings.png) +## Usage To use this plugin, simply go into its settings and add a new frame, either from a preset shipped with the plugin, or a custom one that you can edit yourself. Each frame's tab can be opened using the 'Custom Frames: Open' command. -Note that this plugin only works on Desktop right now. \ No newline at end of file +Note that this plugin only works on Desktop right now. + +## Presets +By default, Custom Frames comes with a few presets that allow you to get new tabs for popular sites up and running quickly. +- Google Keep, optimized for a narrow side tab + +If you create a frame that you think other people would like, don't hesitate to create a pull request with [a new preset](https://github.com/Ellpeck/ObsidianCustomFrames/blob/master/main.ts#L8). + +## Roadmap +- Allow setting a custom icon for each tab +- Possibly allow executing custom JavaScript in iframes (though security implications still need to be explored) \ No newline at end of file