Skip to content

Commit afdafe0

Browse files
Oliver Kleeoliverklee
Oliver Klee
authored andcommitted
[TASK] Refer to the new REST API implementation
Also document that this implementation of the REST API v2 will be removed soon. [ci skip]
1 parent 7820774 commit afdafe0

File tree

2 files changed

+32
-10
lines changed

2 files changed

+32
-10
lines changed

README.md

+19-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
1-
# phplist-plugin-restapi
2-
### REST API plugins for phpList
3-
4-
This repository contains two separate API plugins for phpList, the REST API Plugin v1 and v2.
1+
# phpList REST API plugin
52

63
[![Build Status](https://travis-ci.org/phpList/phplist-plugin-restapi.svg?branch=master)](https://travis-ci.org/phpList/phplist-plugin-restapi)
74

8-
v1 is stable and will take PRs and bugfixes.
95

10-
v2 is under active development and should be used and extended where possible.
6+
## About this plugin
7+
8+
This repository contains the REST API Plugin v1 for phpList 3. It is contained
9+
within the `plugins` folder, along with respective documentation and
10+
plugin-specific tests.
11+
12+
v1 is stable and will take pull requests and bugfixes.
13+
14+
15+
## About the REST API plugin v2
16+
17+
v2 of the REST API plugin builds on phpList 4. It is under active development
18+
and should be used and extended where possible.
19+
20+
It lives in a [separate repository](https://github.com/phpList/rest-api).
1121

12-
Both plugins are contained within the `plugins` folder, along with respective documentation and plugin-specific tests.
22+
There also is an old, unfinished implementation of the REST API plugin v2 in
23+
the directory [plugins/restapi2/](plugins/restapi2). This implementation will
24+
be removed soon.

plugins/restapi2/README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
1-
REST API
2-
========
1+
# REST API v2 (old implementation)
32

4-
**License: GPLv3 or later**
3+
4+
## License
5+
6+
GPLv3 or later
7+
8+
9+
## About this plugin
510

611
The plugin provides a REST API to phpList.
712
Development by [Sam Tuke](http://samtuke.com), [Michiel
813
Dethmers](http://phplist.com). Based on work by [Andreas
914
Ek](https://twitter.com/ekandreas) of Flowcom AB.
1015

16+
Note: This is an old, unfinished implementation of the REST API plugin v2. It
17+
will be removed soon. Instead, there is the new implementation in a
18+
[separate repository](https://github.com/phpList/rest-api)
19+
20+
1121
Commands
1222
--------
1323

0 commit comments

Comments
 (0)