Skip to content

Commit

Permalink
Partial #5 - working on README
Browse files Browse the repository at this point in the history
  • Loading branch information
Talal-A committed Dec 29, 2024
1 parent 3e31a13 commit c8a4433
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# Obsidian + Paperless-ngx
# Obsidian ❤️ Paperless-ngx

⚠️ Under construction - this plugin is not ready for any public consumption ⚠️
⚠️ 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

0 comments on commit c8a4433

Please sign in to comment.