commit 14449d3f3f96ae497bec55901dc9f8ce2f3f52f7 Author: Gary Hansen Date: Wed Jun 21 01:12:42 2017 +0000 README.md created online with Bitbucket diff --git a/README.md b/README.md new file mode 100644 index 0000000..624e170 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# README # + +Need a quick way to send a message to slack from the command line? This will do the job (and not much else) + +Useful inside scripts to report back to an administrator. + +### What is this repository for? ### + +* Shell script that uses curl to send a message to slack +* Very simple +* [Hansen IT Solutions](https://hansenit.solutions) + +### How do I get set up? ### + +* Summary of set up + Install curl to your system + Copy the slackecho script to your binary path +* Configuration + Update the SLACKURL with your own (todo: create a config file and a way to setup the file on first run) +* Dependencies + curl +* How to run tests + N/A + +### Contribution guidelines ### + +TODO +* Writing tests +* Code review +* Other guidelines + +### Who do I talk to? ### + +* gary@hansenit.solutions \ No newline at end of file