Skip to content

Commit

Permalink
Adding readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
coddingtonbear committed Jan 27, 2022
1 parent 22fc8ae commit 84a69b9
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Local REST API for Obsidian

Docs: https://coddingtonbear.github.io/obsidian-local-rest-api/
See our interactive docs: https://coddingtonbear.github.io/obsidian-local-rest-api/

Have you ever needed to automate interacting with your notes? This plugin gives Obsidian a REST API you can interact with your notes from other tools so you can automate what you need to automate.

This plugin provides a secure HTTPS interface gated behind api key authentication that allows you to:

- Read, create, update or delete existing notes. There's even a `PATCH` HTTP method for inserting content into your section.
- List notes stored in your vault.
- Create and fetch periodic notes.
- Execute commands and list what commands are available.

Hopefully you find this as useful as I do!

0 comments on commit 84a69b9

Please sign in to comment.