From 901b9526324e61a8c31aa4b046aec0cd76867bfd Mon Sep 17 00:00:00 2001
From: Django Doucet <djunglelabs@gmail.com>
Date: Fri, 27 Dec 2019 20:44:12 -0500
Subject: [PATCH] fix readme

---
 readme.md  | 64 +++++++++++++++++++++++++++++++++++++++---------------
 readme.txt | 15 ++++++++++---
 2 files changed, 58 insertions(+), 21 deletions(-)

diff --git a/readme.md b/readme.md
index 40d326e..ab6c75f 100644
--- a/readme.md
+++ b/readme.md
@@ -1,41 +1,69 @@
-== Description ==
+# FediEmbedi
+
+Display your Fediverse timeline in a widget
+
+
+## Description
 
 > 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").
 
-= 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
 
 e.g.
 
-1.  Upload `fediembedi` to the `/wp-content/plugins/` directory
-2.  Activate the plugin through the 'Plugins' menu in WordPress
-3.  Connect to your fediverse instance by visiting the configuration page in Settings -\> FediEmbedi
+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? =
+## 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
diff --git a/readme.txt b/readme.txt
index 5397bd3..823ec9f 100644
--- a/readme.txt
+++ b/readme.txt
@@ -15,6 +15,8 @@ Display your Fediverse timeline in a widget
 
 > FediEmbedi is beta software.
 
+FediEmbedi will display your Mastodon, Pleroma, or Pixelfed timeline in a widget, with various display options.
+
 = Currently supported software =
 * Mastodon
 * Pleroma
@@ -30,8 +32,8 @@ For the time being development will happen on [git.feneas.org](https://git.fenea
 
 = 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)
+I will be making frequent updates in the coming days,
+if you want updates from within Wordpress admin, I suggest installing [Github Updater](https://github.com/afragen/github-updater)
 as a companion plugin.
 
 == Installation ==
@@ -44,6 +46,10 @@ e.g.
 1. Activate the plugin through the 'Plugins' menu in WordPress
 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 ==
 
 = 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 ==
 
+= 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/).
+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 =
 The CSS and SVG icon come from the Mastodon project