Update README

README.md

@@ -1,39 +1,36 @@
-# SlackMattermostEmoji
+# Slack Mattermost Emoji
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/slack_mattermost_emoji`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem is a simple script to download all the custom emoji in a Slack
+workspace and upload them to a Mattermost instance.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'slack_mattermost_emoji'
+```
+$ git clone https://git.simulacrum.party/simulacrumparty/slack_mattermost_emoji.git
+$ cd slack_mattermost_emoji
+$ bundle
+$ cp .env.sample .env
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
+Fill in the relevant values in .env and you should be all set!
 
-    $ gem install slack_mattermost_emoji
+(requires Ruby and Bundler to be installed)
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
+$ bin/slack-mattermost-emoji
+```
 
-## Contributing
+## Tests
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slack_mattermost_emoji.
+###🚨🚨🚨 WARNING 🚨🚨🚨
+Running the test suite _will_ upload actual files to your actual Mattermost
+instance.
 
+```
+$ rspec
+```
 
 ## License