Docs

README.md

@@ -0,0 +1,22 @@
+# Github Embed
+
+Plugin that allows you to embed details about a github user, or repo just by pasting in the repo URL as you would any other embed source. 
+
+## Installation
+
+1. Upload the plugin to the `/wp-content/plugins/` directory
+2. Activate the plugin through the 'Plugins' menu in WordPress
+3. Paste a Github repo, or user URL into a post, or page
+
+## Frequently Asked Questions
+
+### Can I change the layout?
+Not yet, we're hoping to add templating - all contributions welcome!
+
+## Screenshots
+
+
+## Changelog
+
+- 1.0
+	- First release