From ebd2492569e7e1bd74078c25d14d14d4fd675198 Mon Sep 17 00:00:00 2001 From: Jonny Harris <148061917+jonnynews@users.noreply.github.com> Date: Fri, 15 Dec 2023 16:33:12 +0000 Subject: [PATCH] Update readme (#238) --- .distignore | 2 -- README.md | 19 ++++++++++++++++--- readme.txt | 16 ---------------- 3 files changed, 16 insertions(+), 21 deletions(-) delete mode 100644 readme.txt diff --git a/.distignore b/.distignore index ca2826f..70e2284 100644 --- a/.distignore +++ b/.distignore @@ -25,12 +25,10 @@ phpunit.xml.dist phpunit-multisite.xml.dist multisite.xml multisite.xml.dist -README.md .phpcs.xml phpcs.xml .phpcs.xml.dist phpcs.xml.dist -README.md wp-cli.local.yml yarn.lock tests diff --git a/README.md b/README.md index 4e76e23..d30cd17 100755 --- a/README.md +++ b/README.md @@ -1,20 +1,33 @@ -# [WP REST API - OAuth 1.0a Server](http://oauth1.wp-api.org/) +# WP REST API - OAuth 1.0a Server + +Contributors: rmccue, rachelbaker, danielbachhuber, joehoyle, spacedmonkey +Tags: json, rest, api, rest-api +Requires at least: 4.4 +Requires PHP: 5.4 +Tested up to: 6.4 +Stable tag: 0.4.2 +License: GPLv2 or later +License URI: http://www.gnu.org/licenses/gpl-2.0.html + +![](assets/banner-1544x500.png) Connect applications to your WordPress site without ever giving away your password. +## Description + This plugin uses the OAuth 1.0a protocol to allow delegated authorization; that is, to allow applications to access a site using a set of secondary credentials. This allows server administrators to control which applications can access the site, as well as allowing users to control which applications have access to their data. This plugin only supports WordPress >= 4.4. The latest stable version is also available from the [WordPress Plugin Directory](https://wordpress.org/plugins/rest-api-oauth1/). -## New to OAuth +### New to OAuth We strongly recommend you use an existing OAuth library. You'll be best off if you understand the authorization process, but leave the actual implementation to well-tested libraries, as there are a lot of edge cases. Start reading from [the Introduction](docs/introduction/README.md) to get started! -## For OAuth Veterans +### For OAuth Veterans If you already know how to use OAuth, here's the lowdown: diff --git a/readme.txt b/readme.txt deleted file mode 100644 index caf73db..0000000 --- a/readme.txt +++ /dev/null @@ -1,16 +0,0 @@ -=== WordPress REST API - OAuth 1.0a Server === -Contributors: rmccue, rachelbaker, danielbachhuber, joehoyle, spacedmonkey -Tags: json, rest, api, rest-api -Requires at least: 4.4 -Requires PHP: 5.4 -Tested up to: 6.4 -Stable tag: 0.4.2 -License: GPLv2 or later -License URI: http://www.gnu.org/licenses/gpl-2.0.html - -== Description == -Connect applications to your WordPress site without ever giving away your password. - -This plugin uses the OAuth 1.0a protocol to allow delegated authorization; that is, to allow applications to access a site using a set of secondary credentials. This allows server administrators to control which applications can access the site, as well as allowing users to control which applications have access to their data. - -This plugin only supports WordPress >= 4.4.