diff --git a/README.md b/README.md index 60e6b28..f53f1df 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ # sensorpush -This is a JavaScript/TypeScript npm module for the SensorPush API. It is lightweight; this module requires ZERO external modules, especially no big `request` or `node-fetch` module. +Own a SensorPush temp/humidity sensor? Or a whole fleet of them? + +This is a JavaScript/TypeScript npm module for the SensorPush API, so you can pull and look at your data from any Node program. For example, you could grab your data and send to external stats services, store in a datbase, trigger your own alerts...whatever. + +It is lightweight; this module requires zero external modules, not even `node-fetch` or `request`. It is unofficial and I'm happy to hand ownership over to the [sensorpush.com](http://www.sensorpush.com) team, or another engineer they approve of. -![SensorPush](http://www.sensorpush.com/assets/DSC_8363-2-sillo-4baaecdaddd21e48ed0b8f3541fcf136fa1a1026600d017002266ca18519146d.png) +![SensorPush](https://github.com/malgorithms/sensorpush/raw/master/media/logo.png) ### Installation @@ -16,8 +20,6 @@ yarn add sensorpush ### A quick example -It's very easy to get all your sensorpush data in a NodeJs program. - ```javascript const sensorpush = require('sensorpush').api const email = 'you@foo.com' @@ -41,3 +43,5 @@ async function main() { main() ``` + +Enjoy! diff --git a/media/logo.png b/media/logo.png new file mode 100644 index 0000000..dfe1b3c Binary files /dev/null and b/media/logo.png differ