Browse Source

Add usage section to readme

pull/15/head
Luke Childs 8 years ago
parent
commit
08f15d8807
  1. 37
      README.md

37
README.md

@ -12,6 +12,43 @@ Client library for the Tor Onionoo API with backend agnostic caching.
npm install --save onionoo
```
## Usage
```js
const Onionoo = require('onionoo');
const onionoo = new Onionoo();
// Get top 10 relays
const query = {
limit: 10,
running: true,
order: '-consensus_weight'
};
onionoo.summary(query).then(response => {
console.log(response.body)
// {
// version:'3.1',
// relays_published:'2016-12-23 09:00:00',
// relays:[
// [Object],
// [Object],
// [Object],
// [Object],
// [Object],
// [Object],
// [Object],
// [Object],
// [Object],
// [Object]
// ],
// bridges_published:'2016-12-23 07:41:03',
// bridges:[]
// }
}
});
```
## License
MIT © Luke Childs

Loading…
Cancel
Save