fediembedi-wordpress-widget.../readme.md

81 lines
1.6 KiB
Markdown

# FediEmbedi
Display your Fediverse timeline in a widget
## Description
> FediEmbedi is beta software.
### Currently supported software
* Mastodon
* Pleroma
* Pixelfed
### Planned supported software
* PeerTube
* *Suggestions?*
### Development
For the time being development will happen on [git.feneas.org](https://git.feneas.org/mediaformat/fediembedi "FediEmbedi").
### Updates
I will be making frequent updates in the coming days, weeks, and won't be tagging releases,
so if you want to benefit from easy updates, I suggest installing [Github Updater](https://github.com/afragen/github-updater)
as a companion plugin.
## Installation
Typical installation procedure
e.g.
1. Upload `fediembedi` to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Connect to your fediverse instance by visiting the configuration page in Settings -> FediEmbedi
## Frequently Asked Questions
### Does this plugin store my login info?
No, this plugin uses oAuth 2.0. You will be sent to login to your Instance
and redirected to your site with a secure token. Similar to how apps connect to your account
## Changelog
### 0.4.0
* Fix for Github updates
### 0.3.0
* Refactor Instance selection and logic
* Updated readme.txt
* Fixed reame.md formatting
* Cleaned up settings form
### 0.2.0
* Make an actual release.
### 0.1.0
* Initial commit.
## Credits
### Mastodon Autopost
The App registration, oAuth connection and portions of the Mastodon API code is based on [Mastodon Autopost](https://wordpress.org/plugins/autopost-to-mastodon/).
### Mastodon
The CSS and SVG icon come from the Mastodon project