diff --git a/README.md b/README.md index aa13015..81c52a2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# wp-fastendponts-depends -Speed up your REST endpoints by using plugins as dependencies +# WP-FastEndpoints + + +
+ +------ +**FastEndpoints Depends** is a way of treating plugins as dependencies to speed up your [WP-FastEndpoints](https://github.com/matapatos/wp-fastendpoints). + +- Explore our docs at **[FastEndpoints Depends Docs »](https://matapatos.github.io/wp-fastendpoints/advanced-user-guide/plugins-as-dependencies/)** + +## Features + +- Only includes the plugins you need for the endpoint +- No code changes needed. Just install and activate this plugin +- Full support with [WP-FastEndpoints](https://github.com/matapatos/wp-fastendpoints) + +## Requirements + +- PHP 8.1+ +- WordPress 6.x +- [composer/installers](https://packagist.org/packages/composer/installers) + +We aim to support versions that haven't reached their end-of-life. + +## Installation + +```bash +Download plugin from WordPress store +Activate plugin - if not using Bedrock make sure to install it as a mu-plugin [mu-plugin](LINK HERE) +``` + +FastEndpoints Depends was created by **[André Gil](https://www.linkedin.com/in/andre-gil/)** and is open-sourced software licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.