Skip to content

Commit

Permalink
docs: Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
matapatos committed Jun 5, 2024
1 parent a7ea9c8 commit 681de5a
Showing 1 changed file with 38 additions and 2 deletions.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
# wp-fastendponts-depends
Speed up your REST endpoints by using plugins as dependencies
# WP-FastEndpoints

<img src="https://raw.githubusercontent.com/matapatos/wp-fastendpoints-depends/main/docs/images/wp-fastendpoints-depends-wallpaper.png" alt="Treating plugins as dependencies">
<p align="center">
<a href="https://github.com/matapatos/wp-fastendpoints-depends/actions"><img alt="GitHub Actions Workflow Status (main)" src="https://img.shields.io/github/actions/workflow/status/matapatos/wp-fastendpoints-depends/tests.yml"></a>
<a href="https://codecov.io/gh/matapatos/wp-fastendpoints-depends" ><img alt="Code Coverage" src="https://codecov.io/gh/matapatos/wp-fastendpoints-depends/graph/badge.svg?token=8N7N9NMGLG"/></a>
<a href="https://packagist.org/packages/matapatos/wp-fastendpoints"><img alt="Latest Version" src="https://img.shields.io/packagist/v/matapatos/wp-fastendpoints"></a>
<a href="https://packagist.org/packages/matapatos/wp-fastendpoints"><img alt="Supported WordPress Versions" src="https://img.shields.io/badge/6.x-versions?logo=wordpress&label=versions"></a>
<a href="https://opensource.org/licenses/MIT"><img alt="Software License" src="https://img.shields.io/badge/MIT"></a>
</p>

------
**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)**.

0 comments on commit 681de5a

Please sign in to comment.