Skip to content

Commit

Permalink
[TASK] Refer to the new REST API implementation
Browse files Browse the repository at this point in the history
Also document that this implementation of the REST API v2 will be removed
soon.

[ci skip]
  • Loading branch information
Oliver Klee authored and oliverklee committed Jun 12, 2017
1 parent 7820774 commit afdafe0
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 10 deletions.
26 changes: 19 additions & 7 deletions README.md
@@ -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.
16 changes: 13 additions & 3 deletions plugins/restapi2/README.md
@@ -1,13 +1,23 @@
REST API
========
# REST API v2 (old implementation)

**License: GPLv3 or later**

## License

GPLv3 or later


## About this plugin

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

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


Commands
--------

Expand Down

0 comments on commit afdafe0

Please sign in to comment.