devol/fediembedi-wordpress-widget-embed-fediverso
1
0
Fork 0
mirror of https://git.feneas.org/mediaformat/fediembedi synced 2025-03-09 01:07:44 +01:00
Code Issues Releases Wiki Activity

fix readme

Browse Source
This commit is contained in:
Django Doucet 2019-12-27 20:44:12 -05:00
parent 179a4107bf
commit 901b952632
2 changed files with 58 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
readme.md
View File

@ -1,41 +1,69 @@
== Description == # FediEmbedi
Display your Fediverse timeline in a widget
## Description
> FediEmbedi is beta software. > FediEmbedi is beta software.
= Currently supported software = \* Mastodon \* Pleroma \* Pixelfed
= Planned supported software = \* PeerTube \* *Suggestions?* ### Currently supported software
* Mastodon
* Pleroma
* Pixelfed
= Development =
### Planned supported software
* PeerTube
* *Suggestions?*
### Development
For the time being development will happen on [git.feneas.org](https://git.feneas.org/mediaformat/fediembedi "FediEmbedi"). 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. ### Updates
== Installation == 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 Typical installation procedure
e.g. e.g.
1. Upload `fediembedi` to the `/wp-content/plugins/` directory 1. Upload `fediembedi` to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress 1. Activate the plugin through the 'Plugins' menu in WordPress
3. Connect to your fediverse instance by visiting the configuration page in Settings -\> FediEmbedi 1. Connect to your fediverse instance by visiting the configuration page in Settings -> FediEmbedi
== Frequently Asked Questions ==
= Does this plugin store my login info? = ## Frequently Asked Questions
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 == ### Does this plugin store my login info?
= 0.1.0 = \* Initial commit. 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
== 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/). ## Changelog
= Mastodon = The CSS and SVG icon come from the Mastodon project
### 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

15
readme.txt
View File

@ -15,6 +15,8 @@ Display your Fediverse timeline in a widget
> FediEmbedi is beta software. > FediEmbedi is beta software.
FediEmbedi will display your Mastodon, Pleroma, or Pixelfed timeline in a widget, with various display options.
= Currently supported software = = Currently supported software =
* Mastodon * Mastodon
* Pleroma * Pleroma
@ -30,8 +32,8 @@ For the time being development will happen on [git.feneas.org](https://git.fenea
= Updates = = Updates =
I will be making frequent updates in the coming days, weeks, and won't be tagging releases, I will be making frequent updates in the coming days,
so if you want to benefit from easy updates, I suggest installing [Github Updater](https://github.com/afragen/github-updater) if you want updates from within Wordpress admin, I suggest installing [Github Updater](https://github.com/afragen/github-updater)
as a companion plugin. as a companion plugin.
== Installation == == Installation ==
@ -44,6 +46,10 @@ e.g.
1. Activate the plugin through the 'Plugins' menu in WordPress 1. Activate the plugin through the 'Plugins' menu in WordPress
1. Connect to your fediverse instance by visiting the configuration page in Settings -> FediEmbedi 1. Connect to your fediverse instance by visiting the configuration page in Settings -> FediEmbedi
or using Github Updater
1. Settings -> Github Updater
1. Install plugin tab -> Plugin URI = `https://git.feneas.org/mediaformat/fediembedi`
== Frequently Asked Questions == == Frequently Asked Questions ==
= Does this plugin store my login info? = = Does this plugin store my login info? =
@ -53,13 +59,16 @@ and redirected to your site with a secure token. Similar to how apps connect to
== Changelog == == Changelog ==
= 0.2.0 =
* Make an actual release.
= 0.1.0 = = 0.1.0 =
* Initial commit. * Initial commit.
== Credits == == Credits ==
= Mastodon Autopost = = 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/). The App registration, oAuth connection and portions of the Mastodon API code are based on [Mastodon Autopost](https://wordpress.org/plugins/autopost-to-mastodon/).
= Mastodon = = Mastodon =
The CSS and SVG icon come from the Mastodon project The CSS and SVG icon come from the Mastodon project