Skip to content

Commit

Permalink
Prepare plugin for V1
Browse files Browse the repository at this point in the history
  • Loading branch information
renatonascalves committed Oct 2, 2024
1 parent 402399b commit 9825e98
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 20 deletions.
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,10 @@
# BuddyPress RESTful API

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

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

## Documentation

We have extensive documentation of each endpoint/components and their CRUD actions: <https://developer.buddypress.org/bp-rest-api/>

## System Requirements (relevant for CI tests only)

* PHP >= 7.4
* WP >= 6.1
* BuddyPress >= Latest

## Installation

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.

## About

WordPress is moving towards becoming a fully-fledged application framework. BuddyPress can benefit from this new API by adding endpoints to access social data.

This plugin provides an easy to use REST API Endpoints for BuddyPress, available via HTTP. Grab your
site's data in simple JSON format, including users, groups, xprofile and more.
Retrieving or updating data is as simple as sending a HTTP request.
This plugin has been deprecated since the V2 of the BP REST API was introduced
at [#9145](https://buddypress.trac.wordpress.org/ticket/9145) and is no longer maintained.
24 changes: 24 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,29 @@
"phpunit": "@test",
"phpcs": "@php ./vendor/bin/phpcs . --basepath=.",
"phpcbf": "@php ./vendor/bin/phpcbf . --basepath=."
},
"archive": {
"exclude": [
"*.xml",
"*.dist",
"*.cache",
"phpcs.xml.dist",
"phpunit.xml.dist",
"wp-env.json",
"composer.json",
"composer.lock",
".editorconfig",
"CHANGELOG.md",
"CONTRIBUTING.md",
"README.md",
".gitignore",
".distignore",
".deployignore",
".github/",
".phpcs/",
"tests/",
"bp-rest-api.zip",
"!vendor/"
]
}
}
File renamed without changes.

0 comments on commit 9825e98

Please sign in to comment.