readme.md 3.31 KB
Newer Older
MediaFormat's avatar
MediaFormat committed
1 2
# FediEmbedi

3
>Display your Fediverse timeline in a widget
MediaFormat's avatar
MediaFormat committed
4

MediaFormat's avatar
MediaFormat committed
5
FediEmbedi will display your Mastodon, Pleroma, Pixelfed, PeerTube timeline with various display options.
MediaFormat's avatar
MediaFormat committed
6

7 8 9 10 11
### How to use shortcodes
* `[mastodon exclude_reblogs="true"]`
* `[pixelfed limit="6"]`
* `[peertube instance="https://peertube.social" actor="channel_name" is_channel="true"]`

MediaFormat's avatar
MediaFormat committed
12
### Currently supported software
13 14 15 16
* [Mastodon](http://joinmastodon.org/)
* [Pleroma](https://git.pleroma.social/pleroma)
* [Pixelfed](https://pixelfed.org/)
* [PeerTube](https://joinpeertube.org/)
MediaFormat's avatar
MediaFormat committed
17

MediaFormat's avatar
MediaFormat committed
18

MediaFormat's avatar
MediaFormat committed
19
### Planned supported software
20 21
* See the [board](https://git.feneas.org/mediaformat/fediembedi/-/boards)
* [Suggestions](https://git.feneas.org/mediaformat/fediembedi/issues)?
MediaFormat's avatar
MediaFormat committed
22 23 24


### Development
MediaFormat's avatar
MediaFormat committed
25

MediaFormat's avatar
MediaFormat committed
26
For the time being development will happen on [git.feneas.org](https://git.feneas.org/mediaformat/fediembedi).
MediaFormat's avatar
MediaFormat committed
27 28


MediaFormat's avatar
MediaFormat committed
29 30
### Updates

31
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.
MediaFormat's avatar
MediaFormat committed
32

MediaFormat's avatar
MediaFormat committed
33

MediaFormat's avatar
MediaFormat committed
34
## Installation
MediaFormat's avatar
MediaFormat committed
35 36 37 38 39

Typical installation procedure

e.g.

MediaFormat's avatar
MediaFormat committed
40 41 42 43 44 45 46 47 48 49
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?

50
No, this plugin uses [OAuth 2.0](https://oauth.net/). You will be sent to login to your Instance
MediaFormat's avatar
MediaFormat committed
51
and redirected to your site with a secure token. Similar to how you would connect a mobile app to your account.
MediaFormat's avatar
MediaFormat committed
52 53 54


## Changelog
MediaFormat's avatar
MediaFormat committed
55

56 57 58 59
### 0.11.1
* Bug fix: Shortcode limit attribute.
* Document: Shortcodes on options page.

MediaFormat's avatar
MediaFormat committed
60 61 62 63 64 65
### 0.11.0
* Feature: PeerTube widget NSFW option.
* Fix: PeerTube number of posts to display.
* Fix: connection issues.
* Fix: Template issues.

66 67 68
### 0.10.5
* Bug fix: Template issues.

69 70 71
### 0.10.4
* Bug fix: Embed included in post edit screen, causing post save issues.

72
### 0.10.3
MediaFormat's avatar
MediaFormat committed
73 74
* Security fix: statuses with visibility marked unlisted, private, and direct could be displayed publicly

75 76 77
### 0.10.0
* Service shortcodes

MediaFormat's avatar
v0.9.1  
MediaFormat committed
78 79 80
### 0.9.0
* Emoji support

81 82 83
### 0.8.5
* CSS for small columns

MediaFormat's avatar
v0.8.4  
MediaFormat committed
84 85 86 87 88 89 90 91 92 93 94 95
### 0.8.4
* Fix large video player

### 0.8.3
* version bump

### 0.8.2
* Add Support links

### 0.8.1
* CSS fix

96 97 98 99 100 101 102
### 0.8.0
* Support PeerTube
* Support separate Mastodon, Pixelfed and PeerTube widgets.

### 0.7.2
* Renamed some classes and constants, and reorganized file structure

103 104 105
### 0.7.1
* Fixed version info preventing auto-updates

MediaFormat's avatar
MediaFormat committed
106 107 108 109 110 111 112 113
### 0.7.0
* Added Pixelfed /embed styles
* Added i18n support to template strings

### 0.6.0
* Updated settings page, with links for finding an instance to join/register
* Clarify widget options

114 115 116
### 0.5.0
* Mirror plugin on Github for use with [Github Updater](https://github.com/afragen/github-updater)

117 118 119
### 0.4.1
* Readme updates

MediaFormat's avatar
MediaFormat committed
120 121 122
### 0.4.0
* Fix for Github updates

MediaFormat's avatar
MediaFormat committed
123
### 0.3.0
MediaFormat's avatar
MediaFormat committed
124
* Refactor Instance selection and logic
MediaFormat's avatar
MediaFormat committed
125
* Updated readme.txt
MediaFormat's avatar
MediaFormat committed
126
* Fixed reame.md formatting
MediaFormat's avatar
MediaFormat committed
127 128 129 130
* Cleaned up settings form

### 0.2.0
* Make an actual release.
MediaFormat's avatar
MediaFormat committed
131

MediaFormat's avatar
MediaFormat committed
132 133
### 0.1.0
* Initial commit.
MediaFormat's avatar
MediaFormat committed
134 135


MediaFormat's avatar
MediaFormat committed
136
## Credits
MediaFormat's avatar
MediaFormat committed
137 138


MediaFormat's avatar
MediaFormat committed
139
### Mastodon Autopost
MediaFormat's avatar
MediaFormat committed
140
The client connection code is based on [Mastodon Autopost](https://wordpress.org/plugins/autopost-to-mastodon/).
MediaFormat's avatar
MediaFormat committed
141

MediaFormat's avatar
MediaFormat committed
142
### FediEmbedi
143
The name FediEmbedi was contributed by [wake.st](https://wake.st/@liaizon)