kstep / pushybullet

Python bindings for Pushbullet (http://pushbullet.com/) API v2 with freedom of usage in mind
33 stars 4 forks source link

Improve real-time events stream documentation #5

Closed jinnatar closed 10 years ago

jinnatar commented 10 years ago

The example for Real-time events stream as written works fine but doesn't really get a novice like me much closer to doing anything useful. I now have an event object that I have no idea what to do with. Could you please add a bit more meat to the example, e.g. printing out the title & URL of a link push from the real-time stream? :-)

jinnatar commented 10 years ago

At least part of my confusion is because the documentation uses both event and ev in examples and explanations interchangably, might be a good idea to harmonize on just one.

kstep commented 10 years ago

Please review updated readme section. Is it clear enough for you now? I'm not a native English speaker, so if you notice any mistakes, feel free to post a PR or an issue. Thank you.

jinnatar commented 10 years ago

That does help quite a bit and is fairly understandable. Thanks!