Skip to content

Commit 035f53a

Browse files
Updated readme.
1 parent 4a04bd2 commit 035f53a

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
# Slack
22

3+
## Setup
4+
5+
The first thing you will need to use this package is a [Slack Workspace](https://slack.com/create) to [install a Slack app into](https://api.slack.com/start).
6+
7+
After that, you will need to add a `webhook` to your app such that you can send and retrieve data from the Slack Workspace.
8+
9+
10+
311
## Usage
412

5-
Here is a simple exmaple:
13+
Here is a simple exmaple:
614
```julia
715
julia> using Slack
816

@@ -19,6 +27,6 @@ julia> response = sendtoslack(data, endpoint)
1927
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).
2028

2129
## 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.
30+
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.
2331

24-
In the meantime, I cannot stop you from using the end point URL I have setup. Please use it responsibily.
32+
In the meantime, I cannot stop you from using the end point URL I have setup. Please use it responsibly.

0 commit comments

Comments
 (0)