From 1eb540d88ed141792bd4709d8da2539f4b506ac0 Mon Sep 17 00:00:00 2001 From: Joshua Coles Date: Fri, 29 Sep 2023 10:43:14 +0100 Subject: [PATCH] Add readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ae7e10b --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Obsidian Note Finder + +A simple web UI which allows for easily finding, creating, and copying Obsidian wiki style links from a given vault. I use this to quickly put links to notes inside non Obsidian contexts, which are then exported to obsidian. + +This requires an Obsidian Beachhead installation which is a service to provide information and interaction with your obsidian vault over the network. Currently, this is comprised of single route `/metadata` which returns the [metadata-extractor](https://github.com/kometenstaub/metadata-extractor) json data file. + +## Dev + +Set the `OBSIDIAN_BEACHHEAD_SERVER` to point the Obsidian Beachhead installation. + +## Prod + +Make sure you reverse proxy the `/metadata` route to the Obsidian Beachhead installation.