diff --git a/README.md b/README.md index 1a5f929..d71f818 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ -weebullet -========= +# weebullet Weechat script to push notifications to Pushbullet. Requires an API key from http://pushbullet.com and a recentish version of Weechat with Python support enabled. + +### Setup +- Place `weebullet.py` in `~/.weechat/python` +- `/script load weebullet.py` +- `/set plugins.var.python.weebullet.api_key YOUR_API_KEY` +- Enjoy! + +### Additional commands +`/send_push_note` - sends a push manually from weechat