From 02cd5713e1359c6c936eb2792020e6ce1556830e Mon Sep 17 00:00:00 2001 From: Christian Bager Bach Houmann <christian@bagerbach.com> Date: Thu, 25 Aug 2022 10:37:15 +0200 Subject: [PATCH] Update README.md --- README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 64 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f416d43..a1f2ca2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,67 @@ # [PodNotes](https://chhoumann.github.io/PodNotes) -You can find the documentation [here](https://chhoumann.github.io/PodNotes). +<h3 align="center">You can find the documentation <a href="https://chhoumann.github.io/PodNotes">here</a>.</h3> -## Demo - +--- + +The one goal for PodNotes is to make it easier to write notes on podcasts. + +Here are the features that will help you do that 👇. + +## Features + +- Mobile friendly +- Podcast player built into Obsidian +- Add any publicly available podcast through search, or custom feeds by URL +- Track played episodes & playback progress +- Create podcast notes from templates with metadata about episodes +- Capture timestamps & link directly to the time in the episode +- Download episodes for offline playback +- Support for non-podcast local audio files +- API that can be used by plugins like [QuickAdd](https://github.com/chhoumann/QuickAdd) or [Templater](https://github.com/silentvoid13/Templater) for custom workflows + +## Installation + +**This plugin is in the Obsidian community plugin store. You can find it by searching in the store.** + +### Installation with BRAT + +BRAT is an Obsidian plugin that helps you test beta plugins and themes. Click [here](obsidian://show-plugin?id=obsidian42-brat) to install it in Obsidian. + +Add `chhoumann/PodNotes` to BRAT with the `Add a beta plugin for testing` command. + +Now follow the appropriate instructions, which most likely will have you go and enable the plugin once it has finished installing. + +### Manual installation + +Go to the [releases](https://github.com/chhoumann/podnotes/releases/latest) page. +Download `main.js` and `manifest.json`. +Create a new directory in your Obsidian vaults `.obsidian/plugins/` folder called `podnotes` and place the downloaded files there. + +Now refresh the plugins in Obsidian and enable PodNotes. + +## Screenshots + +### Demo + + + +### Podcast Grid + + + +### Episode List + + + +### Player + + + +### Podcast Note Editing + + + +### Podcast search + + -- GitLab