Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesb committed Apr 28, 2021
2 parents 176058c + be57b81 commit e2ea9f1
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
## Obsidian Incremental Writing Plugin
# Obsidian Incremental Writing Plugin

## How to install the plugin
This plugin allows you to do incremental writing in Obsidian. Notes and blocks can be added to queues that will schedule reviews of your writing over time.

Go to releases. Download the zip file. Unzip into your obsidian plugins directory.
I made a video explaining incremental writing using an earlier version of the plugin [here](https://youtu.be/LLS_8Y744lk). I will create an updated version soon!

## Using the plugin
### Notes

- This plugin adds a button to the search pane using private Obsidian APIs which could cause the plugin to break when Obsidian updates until I have time to fix it.
- If you are using Vim mode, adding a block to the queue must be done with a hotkey because using ctrl+p to open the command palette causes the cursor to move up a line, so the wrong block will get added.

NOTE: If you are using Vim mode, adding a block to the queue must be done with a hotkey because using ctrl+p to open the command palette causes the cursor to move up a line.
## Using the plugin

If you have installed the nldates plugin, you can use natural language when you are asked to provide a date eg. "tomorrow" or "in two weeks".

Expand All @@ -26,3 +29,9 @@ There are currently 10 hotkey / command palette commands and a couple of buttons
You can also add the output from an inbuilt search to a queue. Do a search and click the button at the top of the search pane to try it out.

You can also right click on folders, files and links to add them to queues through the context menu.

## Support

I want to put all of my energy into these projects and work on them full time! I also want to keep as much of my content open source and freely available as possible. That those seeking knowledge may find it!

If you would like to support my work, I have a [Patreon page](https://www.patreon.com/experimental_learning) with rewards for each tier or you can [buy me a coffee](https://www.buymeacoffee.com/experilearning).

0 comments on commit e2ea9f1

Please sign in to comment.