Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Refer to the new REST API implementation
Also document that this implementation of the REST API v2 will be removed soon. [ci skip]
- Loading branch information
1 parent
7820774
commit afdafe0
Showing
2 changed files
with
32 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,24 @@ | ||
# phplist-plugin-restapi | ||
### REST API plugins for phpList | ||
|
||
This repository contains two separate API plugins for phpList, the REST API Plugin v1 and v2. | ||
# phpList REST API plugin | ||
|
||
[![Build Status](https://travis-ci.org/phpList/phplist-plugin-restapi.svg?branch=master)](https://travis-ci.org/phpList/phplist-plugin-restapi) | ||
|
||
v1 is stable and will take PRs and bugfixes. | ||
|
||
v2 is under active development and should be used and extended where possible. | ||
## About this plugin | ||
|
||
This repository contains the REST API Plugin v1 for phpList 3. It is contained | ||
within the `plugins` folder, along with respective documentation and | ||
plugin-specific tests. | ||
|
||
v1 is stable and will take pull requests and bugfixes. | ||
|
||
|
||
## About the REST API plugin v2 | ||
|
||
v2 of the REST API plugin builds on phpList 4. It is under active development | ||
and should be used and extended where possible. | ||
|
||
It lives in a [separate repository](https://github.com/phpList/rest-api). | ||
|
||
Both plugins are contained within the `plugins` folder, along with respective documentation and plugin-specific tests. | ||
There also is an old, unfinished implementation of the REST API plugin v2 in | ||
the directory [plugins/restapi2/](plugins/restapi2). This implementation will | ||
be removed soon. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters