Update README
Otavio Cordeiro
26
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# Micro.blog Publish for Obsidian
|
||||
|
||||
[Micro.blog](https://micro.blog/) Publish for [Obsidian](https://obsidian.md/) is a community maintained plugin to publish notes to a Micro.blog blog.
|
||||
Micro.blog Publish for [Obsidian](https://obsidian.md/) is a community maintained plugin to publish notes to a [Micro.blog](https://micro.blog/) blog.
|
||||
|
||||
## Installing
|
||||
|
||||
|
|
@ -10,21 +10,29 @@ This plugin will be available via *Community Plugins* soon.
|
|||
|
||||
### Preferences
|
||||
|
||||
In preferences it's possible to set the application token, required to post on Micro.blog, default tags, and default post visibility.
|
||||
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).
|
||||
|
||||
|
||||
|
||||
|
||||
Once logged in, the plugin allows to set default values for tags, post visibility, and default blog (in case the user has more than one hosted blog). These default values will be used when posting to Micro.blog.
|
||||
|
||||
|
||||
|
||||
### Command
|
||||
|
||||
Publishing can be triggered using Obsidian's command palette.
|
||||
Micro.blog Publish is triggered using Obsidian's command palette.
|
||||
|
||||
|
||||
|
||||
|
||||
### Publish
|
||||
|
||||
Before publishing, it's possible to add a title to the post and override the post visiblity.
|
||||
Before publishing, it's possible to edit the title, override default values, and/or select a different blog to post to.
|
||||
|
||||
|
||||
|
||||
|
||||
After publishing, a confirmation window with the post links is presented.
|
||||
|
||||
|
||||
|
||||
## Building from source
|
||||
|
||||
|
|
@ -49,9 +57,9 @@ Restart Obsidian and enable the plugin from *Community Plugins* in Preferences.
|
|||
|
||||
1. Fork this repository and follow the steps from the previous section using the forked repository instead
|
||||
2. Create a feature branch for the changes
|
||||
3. Commit the changes and push them to the forked repository
|
||||
3. Commit the changes and push them to the forked repository
|
||||
4. Submit a pull request
|
||||
|
||||
## Disclaimer
|
||||
|
||||
This project neither affiliated with Micro.blog nor Obsidian. This is a community maintained plugin.
|
||||
This project is neither affiliated with Micro.blog nor Obsidian. This is a community maintained plugin.
|
||||
|
After Width: | Height: | Size: 217 KiB |
|
After Width: | Height: | Size: 238 KiB |
|
After Width: | Height: | Size: 397 KiB |
|
After Width: | Height: | Size: 358 KiB |
|
After Width: | Height: | Size: 403 KiB |
|
Before Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 81 KiB |
|
Before Width: | Height: | Size: 88 KiB |