diff --git a/README.md b/README.md index 1aa312c..5a11589 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ -# Obsidian + Paperless-ngx +# Obsidian ❤️ Paperless-ngx -⚠️ Under construction - this plugin is not ready for any public consumption ⚠️ \ No newline at end of file +⚠️ Under construction - this plugin is not ready for any public consumption ⚠️ + +This plugin allows users to easily insert PDFs from their self-hosted paperless-ngx instance into their Obsidian notes. + +## Features + +- View all documents on your paperless-ngx instance from within the comfort of your Obsidian vault. +- One-click insertion of one or many documents into your vault. + +## Prerequisites +This assumes you have a working version of [paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) hosted. It does not necessarily need to be remotely accessible. This decision is left up to the reader. + +You must also have the ✨amazing✨ [PDF++](https://github.com/RyotaUshio/obsidian-pdf-plus) plugin installed! + +## Setup + +**Paperless-ngx** + +1. ... + +**Obsidian** + +1. Install the plugin. +1. Install [PDF++](https://github.com/RyotaUshio/obsidian-pdf-plus). +1. Fill in the following settings: + - Paperless URL: full url to your paperless-ngx instance. Do not include the trailing `/`. + - Paperless authentication token: TK + - TK