From 5d221503ecc4520e882630e78f0ed91f98c1b2f7 Mon Sep 17 00:00:00 2001
From: Django Doucet <djunglelabs@gmail.com>
Date: Thu, 26 Dec 2019 16:51:48 -0500
Subject: [PATCH] readme.md

---
 fediembedi.php |  4 ++--
 readme.md      | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 2 deletions(-)
 create mode 100644 readme.md

diff --git a/fediembedi.php b/fediembedi.php
index 1d180e6..697bb71 100644
--- a/fediembedi.php
+++ b/fediembedi.php
@@ -4,7 +4,7 @@
  * Plugin URI: https://git.feneas.org/mediaformat/fediembedi
  * GitHub Plugin URI: https://git.feneas.org/mediaformat/fediembedi
  * Description: A widget to show your Mastodon profile timeline
- * Version: 0.1.0
+ * Version: 0.1.1
  * Author: mediaformat
  * Author URI: https://mediaformat.org
  * License: GPL2
@@ -123,7 +123,7 @@ class FediConfig
           if (strpos($instance_info->version, 'Pixelfed') === false) {
             wp_enqueue_style( 'fediembedi', plugin_dir_url( __FILE__ ) . 'mastodon-light.css', array(), filemtime(plugin_dir_path( __FILE__ ) . 'mastodon-light.css') );
           } else {
-            //https://css-tricks.com/lozad-js-performant-lazy-loading-images/ lazyloading for background images 
+            //https://css-tricks.com/lozad-js-performant-lazy-loading-images/ lazyloading for background images
             wp_enqueue_style( 'fediembedi', plugin_dir_url( __FILE__ ) . 'pixelfed-light.css', array(), filemtime(plugin_dir_path( __FILE__ ) . 'pixelfed-light.css') );
           }
         }
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..40d326e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,41 @@
+== 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
+2.  Activate the plugin through the 'Plugins' menu in WordPress
+3.  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.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