mirror of
https://github.com/Ellpeck/ObsidianCustomFrames.git
synced 2024-11-14 14:59:08 +01:00
improve readme
This commit is contained in:
parent
4805efb216
commit
bfb6ad2209
1 changed files with 12 additions and 1 deletions
13
README.md
13
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.
|
||||
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)
|
Loading…
Reference in a new issue