Update README.md
This commit is contained in:
parent
75f4287aa3
commit
5c1884f059
1 changed files with 9 additions and 9 deletions
18
README.md
18
README.md
|
@ -6,19 +6,19 @@
|
|||
|
||||
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 defaults while also empowering you to control how your footnotes are being displayed.
|
||||
***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.
|
||||
***footnotes*** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts—those footnotes we know from offline publishing.
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Read the contributing guidelines
|
||||
1. Clone this repository (`git clone git@github.com:Rumperuu/footnotes.git`)
|
||||
1. Clone this repository (`git clone git@github.com:markcheret/footnotes.git`)
|
||||
1. Install [Composer](https://getcomposer.org/download/), if you don't have it already
|
||||
1. Install dependencies (`composer install`)
|
||||
1. Create a new branch from `main` (`git checkout -b <your-descriptive-branch-name>`)
|
||||
1. When you're finished, commit your changes to the remote version of your branch
|
||||
and submit a [pull request](https://github.com/Rumperuu/footnotes/pulls).
|
||||
and submit a [pull request](https://github.com/markcheret/footnotes/pulls).
|
||||
|
||||
## Checking WP Coding Standard Compliance
|
||||
|
||||
|
@ -39,13 +39,13 @@ Unit tests are TODO.
|
|||
|
||||
## Main Features
|
||||
|
||||
- Fully customizable **footnotes** start and end shortcodes;
|
||||
- Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text;
|
||||
- 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;
|
||||
- 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;
|
||||
- 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
|
||||
|
@ -63,4 +63,4 @@ The current version is available on the [WordPress.org Plugin Directory](https:/
|
|||
|
||||
## Acknowledgements
|
||||
|
||||
Huge thanks to every footnotes user, contributor, bug reporter, feature requester and fan!
|
||||
Huge thanks to every ***footnotes user***, contributor, bug reporter, feature requester and fan!
|
||||
|
|
Reference in a new issue