Skip to content

Commit

Permalink
Update README with additional resources
Browse files Browse the repository at this point in the history
- Specify preference for SSL
- Link to WP-API client documentation
  • Loading branch information
kadamwhite committed Dec 3, 2017
1 parent e911142 commit 9e9d526
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
This plugin adds Basic Authentication to a WordPress site.

Note that this plugin requires sending your username and password with every
request, and should only be used for development and testing. We strongly
recommend using the [OAuth 1.0a][oauth] authentication handler for production.
request, and should only be used over SSL-secured connections or for local
development and testing. Without SSL we strongly recommend using the
[OAuth 1.0a][oauth] authentication handler in production environments.

## Installing
1. Download the plugin into your plugins directory
Expand All @@ -17,7 +18,7 @@ examples are listed below.
### cURL

```sh
curl --user admin:password http://example.com/wp-json/
curl --user admin:password https://example.com/wp-json/
```

### WP_Http
Expand All @@ -30,5 +31,17 @@ $args = array(
);
```

### [node-wpapi][]

```js
const WPAPI = require('./wpapi')
const wp = new WPAPI({
endpoint: 'https://example.com/wp-json',
username: 'editor',
password: 'password'
});
```

[oauth]: https://github.com/WP-API/OAuth1
[RFC2617]: https://tools.ietf.org/html/rfc2617
[node-wpapi]: http://wp-api.org/node-wpapi/

1 comment on commit 9e9d526

@McMike4
Copy link

@McMike4 McMike4 commented on 9e9d526 Sep 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My localhost works perfectly fine with ssl installed except when I use the Basic Auth plugin.
Could you tell me how to resolve this issue?
Thanks in advance

Please sign in to comment.