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

80 lines
1.8 KiB
Markdown
Raw Normal View History

2019-12-28 02:44:12 +01:00
# FediEmbedi
2020-01-03 22:32:28 +01:00
TLDR; Display your Fediverse timeline in a widget
2019-12-26 22:51:48 +01:00
FediEmbedi will display your Mastodon, Pleroma, or Pixelfed timeline in a widget, with various display options.
2019-12-26 22:51:48 +01:00
2019-12-28 02:44:12 +01:00
### Currently supported software
* Mastodon
* Pleroma
* Pixelfed
2019-12-26 22:51:48 +01:00
2019-12-28 02:44:12 +01:00
### Planned supported software
* PeerTube
* *Suggestions?*
### Development
2019-12-26 22:51:48 +01:00
2020-01-03 22:32:28 +01:00
For the time being development will happen on [git.feneas.org](https://git.feneas.org/mediaformat/fediembedi).
2019-12-26 22:51:48 +01:00
2019-12-28 02:44:12 +01:00
### Updates
The plugin is under active development, to keep FediEmbedi updated install [Github Updater](https://github.com/afragen/github-updater) as a companion plugin, and it will manage updates from within your Wordpress installation.
2019-12-28 02:44:12 +01:00
2019-12-26 22:51:48 +01:00
2019-12-28 02:44:12 +01:00
## Installation
2019-12-26 22:51:48 +01:00
Typical installation procedure
e.g.
2019-12-28 02:44:12 +01:00
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](https://oauth.net/). You will be sent to login to your Instance
and redirected to your site with a secure token. Similar to how you would connect a mobile app to your account
2019-12-28 02:44:12 +01:00
## Changelog
2019-12-26 22:51:48 +01:00
### 0.5.0
* Mirror plugin on Github for use with [Github Updater](https://github.com/afragen/github-updater)
### 0.4.1
* Readme updates
2019-12-30 17:12:11 +01:00
### 0.4.0
* Fix for Github updates
2019-12-28 02:49:28 +01:00
### 0.3.0
2019-12-30 17:12:11 +01:00
* Refactor Instance selection and logic
2019-12-28 02:49:28 +01:00
* Updated readme.txt
2019-12-30 17:12:11 +01:00
* Fixed reame.md formatting
2019-12-28 02:49:28 +01:00
* Cleaned up settings form
### 0.2.0
* Make an actual release.
2019-12-26 22:51:48 +01:00
2019-12-28 02:44:12 +01:00
### 0.1.0
* Initial commit.
2019-12-26 22:51:48 +01:00
2019-12-28 02:44:12 +01:00
## Credits
2019-12-26 22:51:48 +01:00
2019-12-28 02:44:12 +01:00
### Mastodon Autopost
2020-01-03 22:32:28 +01:00
The client connection code is based on [Mastodon Autopost](https://wordpress.org/plugins/autopost-to-mastodon/).
2019-12-26 22:51:48 +01:00
2020-01-03 22:32:28 +01:00
### FediEmbedi
The name FediEmbedi was contributed by [@liaizon@wake.st](https://social.wake.st/@liaizon)