diff --git a/README.md b/README.md index 2ed4f31..429b211 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,10 @@ This plugin allows you to push your [Obsidian](https://obsidian.md/) notes to [Umbraco 15+](https://umbraco.com) as a content item. +It uses the Management API within Umbraco to create notes in Markdown format. You will need to create an API user in Umbraco for this to work. + To see how to use this plugin with Obsidian, check out the [Wiki pages](https://github.com/OwainWilliams/umbpublisher/wiki) + +## Contirbutions + +All contributions are welcome. This project is written in Typescript and is Open Source. If you have features you'd like added, feel free to create a new [issue](https://github.com/OwainWilliams/umbPublisher/issues).