Skip to content

Update usage instructions to be clearer on how to use the access token #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 24, 2017
Merged

Update usage instructions to be clearer on how to use the access token #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ var wpcomOAuth = require('wpcom-oauth-cors')('<client-id>');

// get auth object
wpcomOAuth.get(function(auth){
// your token is here auth.access_token!
// Here, your token is available as auth.access_token
// e.g.:
// var wpcom = require('wpcom');
// var wpc = wpcom(auth.access_token);
});

// clean stored token
Expand Down Expand Up @@ -53,6 +56,27 @@ Create a wpcomOAuth instance giving `client_id` (String) and optional parameters

### wpcomOAuth.token()


## Example

This snippet will log a posts array from site with id `123456`.

```js
var wpcom = require('wpcom');
var wpcomOAuth = require('wpcom-oauth-cors')('<client-id>');

// get auth object
wpcomOAuth.get(function(auth){
// Here, your token is available as auth.access_token
var wpc = wpcom( auth.access_token );
var mySite = wpc.site( 123456 );
mySite.postsList({ number: 50, fields: "author,URL,title,geo" }, function(err, list) {
console.log( list );
});
});

```

## Test

* Compile testing js file
Expand Down