Create README.md

README.md

@@ -0,0 +1,37 @@
+# footnotes
+
+## Description
+
+Featured on [wpmudev](http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/) --- cheers for the review, folks!
+
+**footnotes** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of current defaults but also empowers you to control how your footnotes are being displayed.
+
+**footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts—those footnotes we know from offline publishing.
+
+## Main Features
+
+- Fully customizable **footnotes** start and end shortcodes;
+- Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text;
+- Responsive *Reference Container* at the end or positioned by shortcode;
+- Display the **footnotes** *Reference Container* inside a Widget;
+- Wide choice of numbering styles;
+- Freely configurable and optional backlink symbol;
+- Configure the **footnotes’** appearance by dashboard settings and Custom CSS style rules;
+- Button in both the Visual and the Text editor to add shortcodes around selection.
+
+## Example Usage
+
+These are a few examples of possible ways to delimit footnotes:
+
+1. Your awesome text((with an awesome footnote))
+2. Your awesome text[ref]with an awesome footnote[/ref]
+3. Your awesome text`<fn>`with an awesome footnote`</fn>`
+4. Your awesome text`custom-shortcode`with an awesome footnote`custom-shortcode`
+
+## Where to get footnotes?
+
+The current version is available on the [WordPress.org Plugin Directory](https://wordpress.org/plugins/footnotes/).
+
+## Acknowledgements
+
+Huge thanks to every footnotes user, contributor, bug reporter, feature requester and fan!