Merge branch 'devel' of git.inhji.de:inhji/obsidian-micropub into devel

README.md

@@ -1,13 +1,26 @@
 # Micropub
 
-Forked from https://github.com/otaviocc/obsidian-microblog
+Micropub is a community maintained plugin for [Obsidian](https://obsidian.md/) to publish notes to a Indieweb-enabled blog with support for [Micropub](https://indieweb.org/Micropub).
 
-Micro.publish is a community maintained plugin for [Obsidian](https://obsidian.md/) to publish notes to a [Micro.blog](https://micro.blog/) blog.
+## Credits
 
-Does this plugin improve your workflow? Say thanks with a coffee.
+- Forked from https://github.com/otaviocc/obsidian-microblog, this was used as the base, since Micro.blog also uses the Micropub standard under the hood
+- With code from https://github.com/lijyze/obsidian-state-switcher, to manipulate the yaml frontmatter of notes
+
+## Donating
+
+Does this plugin improve your workflow? Say thanks with a coffee to the [original author](https://github.com/otaviocc).
 
 [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Z8Z0C9KPT)
 
+## Status
+
+This plugin is considered alpha software. Even though the publish workflow lets you publish notes, there are a lot of things that are not implemented, most notably:
+
+- **Proper [RelMeAuth Flow](https://indieweb.org/RelMeAuth)**, for now you need to generate a static token that is validated by the Micropub endpoint and save that token in the settings of the plugin.
+- **Updating posts**, once you have published at note, it is not possible to publish it again, making use of the [Micropub update action](https://www.w3.org/TR/micropub/#h-update).
+- **Writing back tags, publish date, etc. to the frontmatter**, as this requires a `q=source` call to the micropub endpoint which is missing at the moment.
+
 ## Installing
 
 This plugin will be available via *Community Plugins* soon.
@@ -16,7 +29,7 @@ This plugin will be available via *Community Plugins* soon.
 
 ### Preferences
 
-From the preferences window it is possible to log in into Micro.blog using an App Token, which can be generated [here](https://micro.blog/account/apps).
+From the preferences window it is possible to log in using Micropub.
 
 ![](images/01-preferences.png)
 
@@ -46,13 +59,13 @@ Clone this repository inside the Obsidian Vault:
 
 ```
 $ cd .obsidian/plugins/
-$ git clone https://github.com/otaviocc/obsidian-microblog
+$ git clone https://git.inhji.de/inhji/obsidian-micropub
 ```
 
 Resolve the plugin dependencies and build it:
 
 ```
-$ cd obsidian-microblog
+$ cd obsidian-micropub
 $ npm i
 $ npm run build
 ```
@@ -68,4 +81,4 @@ Restart Obsidian and enable the plugin from *Community Plugins* in Preferences.
 
 ## Disclaimer
 
-This project is neither affiliated with Micro.blog nor Obsidian. This is a community maintained plugin.
+This project is neither affiliated with Obsidian. This is a community maintained plugin.

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "micropub-publish-plugin",
 	"name": "Micropub",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"minAppVersion": "0.15.0",
 	"description": "Publish notes to your own site with Micropub",
 	"author": "Inhji",

package-lock.json

@@ -1,12 +1,12 @@
 {
 	"name": "microblog-publish-plugin",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"lockfileVersion": 2,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "microblog-publish-plugin",
-			"version": "2.0.0",
+			"version": "2.1.0",
 			"license": "MIT",
 			"devDependencies": {
 				"@types/node": "^18.0.0",

versions.json

@@ -1,4 +1,5 @@
 {
 	"1.6.0": "0.15.0",
-	"2.0.0": "0.15.0"
+	"2.0.0": "0.15.0",
+	"2.1.0": "0.15.0"
 }