Skip to content

Commit b5ac253

Browse files
committed
Updating README
1 parent 00b7401 commit b5ac253

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@
33
# slack-java-webhook
44
Java Client to Slack's Webhook feature.
55

6+
## Dependencies
7+
8+
For Maven,
9+
```xml
10+
<dependency>
11+
<groupId>in.ashwanthkumar</groupId>
12+
<artifactId>slack-java-webhook</artifactId>
13+
<version>0.0.1</version>
14+
</dependency>
15+
```
16+
17+
For SBT,
18+
```
19+
libraryDependencies += "in.ashwanthkumar" % "slack-java-webhook" % "0.0.2"
20+
```
21+
622
## Usage
723
```java
824
Slack slack = new Slack("https://hooks.slack.com/services/...");
@@ -11,3 +27,25 @@ slack.icon(":smiling_imp:") // Anything from http://www.emoji-cheat-sheet.com/ s
1127
.displayName("slack-java-client")
1228
.push(new SlackMessage("Text from my Slack-Java-Client"));
1329
```
30+
31+
## Notes
32+
With `SlackMessage` you can create rich text like
33+
```java
34+
new SlackMessage()
35+
.text("Some text can be ")
36+
.italic("Italic")
37+
.text(". :)")
38+
```
39+
40+
Available methods
41+
- `text`
42+
- `link`
43+
- `bold`
44+
- `italic`
45+
- `code`
46+
- `preformatted`
47+
- `quote`
48+
49+
## License
50+
51+
http://www.apache.org/licenses/LICENSE-2.0

0 commit comments

Comments
 (0)