Skip to content

Commit 4a04bd2

Browse files
Update README.md
1 parent 65f2fc0 commit 4a04bd2

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
11
# Slack
2+
3+
## Usage
4+
5+
Here is a simple exmaple:
6+
```julia
7+
julia> using Slack
8+
9+
julia> endpoint = "/services/TQVJBU534/BR8C1LMPS/42thawJz34SWSgZCpniyLBSE"
10+
"/services/TQVJBU534/BR8C1LMPS/42thawJz34SWSgZCpniyLBSE"
11+
12+
julia> data = "Hello World"
13+
"Hello World"
14+
15+
julia> response = sendtoslack(data, endpoint)
16+
"ok"
17+
```
18+
19+
To learn more about how data should be formatted before sending it as a argument to the above code, check out the [Slack API Docs](https://api.slack.com/messaging/composing/formatting).
20+
21+
## Testing
22+
I have gone through the trouble of setting up a Slack Workspace in order to test this package. After this is all stabilized, I will remove the endpoint from the Slack Workspace and deprecate the examples you see throughout this repo.
23+
24+
In the meantime, I cannot stop you from using the end point URL I have setup. Please use it responsibily.

0 commit comments

Comments
 (0)