From d06f41582c3007c61547648c7210c2c80eb0bcd5 Mon Sep 17 00:00:00 2001 From: Tom Jowitt Date: Sun, 4 Jun 2017 19:44:47 +1000 Subject: [PATCH] Updated documentation --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d678f6d..a82400f 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,17 @@ [![CircleCI](https://circleci.com/gh/madecomfy/slack-cleanup/tree/master.svg?style=svg&circle-token=4aee14214b029ff6bcb7664e8c403ef1288e84f4)](https://circleci.com/gh/madecomfy/slack-cleanup/tree/master) -A program for cleaning up slack files to free up space. +A program for cleaning up slack file uploads. Useful if you keep hitting limits on your plan. -## Setup +## Installing Slack Cleanup -Install Slack Cleanup - - go get github.com/madecomfy/slack-cleanup + go get -u github.com/madecomfy/slack-cleanup You will need to generate an API token that has permission to delete files. Add this token to your environment -variables (we use Direnv to manage env vars). +variables. At MadeComfy we use [Direnv](https://direnv.net/) to manage local environment variables. export SLACK_API_TOKEN=xoxp-111111-1111111-1111111-1111111-111111 + +## Running Slack Cleanup + + slack-cleanup