From 5c62a48451ccebf7c7b4c24bc034fa2ae85f7463 Mon Sep 17 00:00:00 2001 From: Benjamin Richards IV Date: Mon, 20 May 2019 15:25:43 -0700 Subject: [PATCH 1/3] Update .gitignore --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index b9d6bd9..48bad7c 100644 --- a/.gitignore +++ b/.gitignore @@ -213,3 +213,6 @@ pip-log.txt #Mr Developer .mr.developer.cfg + +#Documentation +formatting.md From fd5380cf6e0121a2ad2dcf69b92db6c192b3886e Mon Sep 17 00:00:00 2001 From: Benjamin Richards IV Date: Mon, 20 May 2019 15:33:28 -0700 Subject: [PATCH 2/3] Improve Documentation Including Formatting --- readme.md | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/readme.md b/readme.md index 940aa29..4c92a24 100644 --- a/readme.md +++ b/readme.md @@ -1,18 +1,22 @@ -=== JSON API User === - -Donate link: -Tags: json api, RESTful user registration, authentication, RESTful Facebook Login, RESTful User Meta and BuddyPress xProfile -Contributors: parorrey -Stable tag: 3.0.0 -Requires at least: 3.0.1 -Tested up to: 5.0.0 -Requires PHP: 5.3 -License: GPLv2 or later -License URI: +# JSON API User + +## Overview Extends the JSON API Plugin to allow RESTful user registration, authentication and many other User Meta, BuddyPress functions. A Pro version is also available. -==Description== +#### Donate link: + + +Contributors: | parorrey, BHRIV (docs) +Stable tag | 3.0.0 +Requires at least | 3.0.1 +Tested up to | 5.0.0 +Requires PHP | 5.3 +License | GPLv2 or later +License URI | + + +## Description JSON API User extends the JSON API Plugin with a new Controller to allow RESTful user registration, authentication, password reset, RESTful Facebook Login, RESTful User Meta and BuddyPress xProfile get and update methods. This plugin is for WordPress/Mobile app developers who want to use WordPress as mobile app data backend. @@ -37,13 +41,12 @@ My other JSON API Auth plugin has also been integrated with this from version 1. Hope this will help some. -Pro Version - JSON API User Plus - -A pro version of this plugin, JSON API User Plus, is available here that supports BuddyPress Messages component, BuddyPress avatar upload and other BuddyPress related functions to integrate BuddyPress features in your mobile app via REST. +#### Pro Version - JSON API User Plus +A pro version of this plugin, [JSON API User Plus](http://www.parorrey.com/solutions/json-api-user-plus/) supports BuddyPress Messages component, BuddyPress avatar upload and other BuddyPress related functions to integrate BuddyPress features in your mobile app via REST. 'JSON API User Plus' includes API key which protects and restricts the endpoint calls. This key can be updated from Settings > User Plus options page. Your app must include this key with every call to get the data from REST API. Please see documentation for calling endpoints examples for 'JSON API User Plus'. -JSON API User Plus features include: +#### JSON API User Plus features include: - Generate Auth Cookie for user authentication - Validate Auth Cookie @@ -67,7 +70,7 @@ JSON API User Plus features include: - BuddyPress Settings - & many more -== Installation == +## Installation First you have to install the JSON API for WordPress Plugin (). @@ -83,7 +86,14 @@ To install JSON API User just follow these steps: 2. Call to get\_currentuserinfo endpoint using Postman 3. Call to validate\_auth\_cookie endpoint using Postman -== Changelog == + + +##### Tags: +json api, RESTful user registration, authentication, RESTful Facebook Login, RESTful User Meta and BuddyPress xProfile + + + +### Changelog = 3.0.0 = From ff9c42ff3659518029db383fa276053f9990debd Mon Sep 17 00:00:00 2001 From: Benjamin Richards IV Date: Mon, 20 May 2019 15:34:47 -0700 Subject: [PATCH 3/3] Update readme.md --- readme.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/readme.md b/readme.md index 4c92a24..6d4e3af 100644 --- a/readme.md +++ b/readme.md @@ -7,6 +7,8 @@ Extends the JSON API Plugin to allow RESTful user registration, authentication a #### Donate link: +Label | Details +------------ | ------------- Contributors: | parorrey, BHRIV (docs) Stable tag | 3.0.0 Requires at least | 3.0.1