From eadae1b3d063651a10e24220ec9f3279f263d76f Mon Sep 17 00:00:00 2001
From: Joey Guerra <github@joeyguerra.com>
Date: Wed, 30 Aug 2023 11:32:10 -0500
Subject: [PATCH] fix: Set Hubot peer depednency to 7 and greater to support
 the latest versions of Hubot (#24)

chore: This Slack Adapter uses Slack's SocketMode and it's HTTP API, which each require a token. So provide some instructions on configuring the environment with those tokens.
---
 README.md    | 30 +++++++++++++++++++++++++++++-
 package.json |  5 ++++-
 2 files changed, 33 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 47526845..9f8d7d53 100644
--- a/README.md
+++ b/README.md
@@ -9,13 +9,41 @@ But I'm going to maintain this fork as I continue to evolve Hubot. So feel free
 ## Installation
 
 ```sh
-npm i @hubot-friends/hubot-slack
+npm i @hubot-friends/hubot-slack hubot
 ```
 
 This is a [Hubot](http://hubot.github.com/) adapter to use with [Slack](https://slack.com).
 
 Comprehensive documentation [is available](https://slackapi.github.io/hubot-slack).
 
+## Adapter Configuration
+
+- Create (or use an existing one) a [Slack Workspace](https://slack.com/get-started#/createnew)
+- Create a [Slack App](https://api.slack.com/apps)
+- Create an App-Level Token and give it `connections:write` scope. This will be the `HUBOT_SLACK_APP_TOKEN` environment variable. The adapter will use this token to authenticate via Slacks Socket Mode (WebSockets)
+- Create a [Bot Token](https://api.slack.com/authentication/token-types#bot). This will be the `HUBOT_SLACK_BOT_TOKEN` environment variable. The adapter will use this token to POST messages to Slack's HTTP API.
+- Make sure to give the Slack App the scope permissions noted below in "Notes on using SocketMode".
+
+## Startup
+
+An example command to start the app on MacOS is the following. Assuming there is a file called `.env` with the following environment variables set:
+
+```sh
+HUBOT_SLACK_APP_TOKEN=xapp-1-...
+HUBOT_SLACK_BOT_TOKEN=xoxb-...
+```
+
+Set the environment variables to the values you created for your Slack Apps App-Level Token (`HUBOT_SLACK_APP_TOKEN`) and Bot Token (`HUBOT_SLACK_BOT_TOKEN`).
+
+```sh
+env $(cat .env | grep -v \"#\" | xargs -0) PORT=8080 hubot -a @hubot-friends/hubot-slack -n mybot
+```
+
+Another way to start the app in MacOS or Linux is:
+
+```sh
+HUBOT_SLACK_APP_TOKEN=xapp-1... HUBOT_SLACK_BOT_TOKEN=xoxb-... PORT=8080 hubot -a @hubot-friends/hubot-slack -n mybot
+```
 
 # Notes on using SocketMode
 
diff --git a/package.json b/package.json
index 9ffd295b..b7067eba 100644
--- a/package.json
+++ b/package.json
@@ -27,7 +27,7 @@
     "@slack/web-api": "^6.8.1"
   },
   "peerDependencies": {
-    "hubot": "^7.x.x"
+    "hubot": ">= 7.0.0"
   },
   "engines": {
     "node": ">= 18.16.0",
@@ -42,5 +42,8 @@
       "next"
     ],
     "dryRun": false
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }