Skip to content

Commit f58a588

Browse files
committed
Add README file
1 parent 24dce8c commit f58a588

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# OAuth 1.0a Server for WordPress
2+
This project is an OAuth 1.0a-compatible authentication method for WordPress.
3+
This is a separate-but-related project to [WP API][], designed to provide
4+
authentication suitable for the API.
5+
6+
## Documentation
7+
8+
Read the [plugin's documentation][docs].
9+
10+
[docs]: https://github.com/WP-API/OAuth1/tree/master/docs
11+
12+
13+
## Quick Setup
14+
15+
Want to test out the OAuth API and work on it? Here's how you can set up your own
16+
testing environment in a few easy steps:
17+
18+
1. Install [Vagrant](http://vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/).
19+
2. Clone [Chassis](https://github.com/sennza/Chassis):
20+
21+
```bash
22+
git clone --recursive [email protected]:sennza/Chassis.git api-tester
23+
vagrant plugin install vagrant-hostsupdater
24+
```
25+
26+
3. Grab a copy of WP API and OAuth API:
27+
28+
```bash
29+
cd api-tester
30+
mkdir -p content/plugins content/themes
31+
cp -r wp/wp-content/themes/* content/themes
32+
git clone [email protected]:WP-API/WP-API.git content/plugins/json-rest-api
33+
git clone [email protected]:WP-API/OAuth1.git content/plugins/oauth-server
34+
```
35+
36+
4. Start the virtual machine:
37+
38+
```bash
39+
vagrant up
40+
```
41+
42+
5. Browse to http://vagrant.local/wp/wp-admin/ and activate the WP API and OAuth
43+
API plugins
44+
45+
```
46+
Username: admin
47+
Password: password
48+
```
49+
50+
6. Refer to the [documentation][docs] on how to connect an OAuth client.

0 commit comments

Comments
 (0)