From afce435b23c0e08f6d6ff28b19ba075993002466 Mon Sep 17 00:00:00 2001 From: Sven Kubiak Date: Thu, 22 Nov 2018 14:48:11 +0100 Subject: [PATCH] Update README.md --- README.md | 67 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 35 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index d35a955..e67aeab 100644 --- a/README.md +++ b/README.md @@ -14,47 +14,50 @@ Usage 1) Add the jpushover dependency to your pom.xml: - - de.svenkubiak - jpushover - x.x.x - - +``` + + de.svenkubiak + jpushover + x.x.x + +``` 2) Use the JPushover object with the required informations were you want - JPushover.newMessage() - .withToken("MyToken") - .withUser("MyUser") - .withMessage("MyMessage") - .push(); - - JPushover.newGlance() - .withToken("MyToken") - .withUser("MyUser") - .withText("MyText") - .push(); - +``` +JPushover.newMessage() + .withToken("MyToken") + .withUser("MyUser") + .withMessage("MyMessage") + .push(); + +JPushover.newGlance() + .withToken("MyToken") + .withUser("MyUser") + .withText("MyText") + .push(); +``` + When using the Message API you can additionally add available options from the official [Pushover documentation][2] You can also validate a user and token using the following method - - boolean valid = JPushover.newMessage() - .withToken("MyToken") - .withUser("MyUser") - .validate(); - +``` +boolean valid = JPushover.newMessage() + .withToken("MyToken") + .withUser("MyUser") + .validate(); +``` If you want more information and/or the response from the Pushover API, use the JPushoverResponse object. - - JPushoverResponse jPushoverResponse = JPushover.newMessage() - .withToken("MyToken") - .withUser("MyUser") - .withMessage("MyMessage") - .push(); - +``` +JPushoverResponse jPushoverResponse = JPushover.newMessage() + .withToken("MyToken") + .withUser("MyUser") + .withMessage("MyMessage") + .push(); +``` The JPushoverResponse will return the raw HTTP status code, along with the raw JSON response and a convenient boolean if the request was successful or not. [1]: https://pushover.net [2]: https://pushover.net/api [3]: https://pushover.net/api -[4]: https://pushover.net/api/glances \ No newline at end of file +[4]: https://pushover.net/api/glances