Skip to content

Commit 9825e98

Browse files
Prepare plugin for V1
1 parent 402399b commit 9825e98

File tree

3 files changed

+27
-20
lines changed

3 files changed

+27
-20
lines changed

README.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,10 @@
11
# BuddyPress RESTful API
22

3-
[![Project Status: Active.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
3+
[![Project Status: Active.](https://www.repostatus.org/badges/latest/inactive.svg)](https://www.repostatus.org/#inactive)
44

55
Access your BuddyPress site's data through an easy-to-use HTTP REST API.
66

77
## Documentation
88

9-
We have extensive documentation of each endpoint/components and their CRUD actions: <https://developer.buddypress.org/bp-rest-api/>
10-
11-
## System Requirements (relevant for CI tests only)
12-
13-
* PHP >= 7.4
14-
* WP >= 6.1
15-
* BuddyPress >= Latest
16-
17-
## Installation
18-
19-
Drop this plugin in the wp-content/plugins directory and activate it. You need at least [WordPress 6.1](https://wordpress.org/download/) and [BuddyPress](https://buddypress.org/download/) to use the plugin.
20-
21-
## About
22-
23-
WordPress is moving towards becoming a fully-fledged application framework. BuddyPress can benefit from this new API by adding endpoints to access social data.
24-
25-
This plugin provides an easy to use REST API Endpoints for BuddyPress, available via HTTP. Grab your
26-
site's data in simple JSON format, including users, groups, xprofile and more.
27-
Retrieving or updating data is as simple as sending a HTTP request.
9+
This plugin has been deprecated since the V2 of the BP REST API was introduced
10+
at [#9145](https://buddypress.trac.wordpress.org/ticket/9145) and is no longer maintained.

composer.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,29 @@
4444
"phpunit": "@test",
4545
"phpcs": "@php ./vendor/bin/phpcs . --basepath=.",
4646
"phpcbf": "@php ./vendor/bin/phpcbf . --basepath=."
47+
},
48+
"archive": {
49+
"exclude": [
50+
"*.xml",
51+
"*.dist",
52+
"*.cache",
53+
"phpcs.xml.dist",
54+
"phpunit.xml.dist",
55+
"wp-env.json",
56+
"composer.json",
57+
"composer.lock",
58+
".editorconfig",
59+
"CHANGELOG.md",
60+
"CONTRIBUTING.md",
61+
"README.md",
62+
".gitignore",
63+
".distignore",
64+
".deployignore",
65+
".github/",
66+
".phpcs/",
67+
"tests/",
68+
"bp-rest-api.zip",
69+
"!vendor/"
70+
]
4771
}
4872
}
File renamed without changes.

0 commit comments

Comments
 (0)