From 7e573bef8422705168287c675e68b223154d93ee Mon Sep 17 00:00:00 2001 From: Khushraj Rathod Date: Fri, 19 Feb 2021 18:16:54 +0530 Subject: [PATCH] Improve README --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++-- assets/logo.svg | 1 + 2 files changed, 54 insertions(+), 2 deletions(-) create mode 100644 assets/logo.svg diff --git a/README.md b/README.md index c967b05..35b0434 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,54 @@ -# Slack Deno Socket Mode +
+ Socket icon +

Slack Deno Socket Mode

+

+ Recieve events from Slack's Events API over a WebSocket connection. Deno port of @slack/socket-mode +

+

+ build status + language + code size + issues + license + version +

+

+ View on deno.land +

+
+
+
+
-Deno port of @slack/events-api +## Usage + +```ts +import "https://deno.land/x/dotenv@v2.0.0/load.ts" +import { SocketModeClient } from "https://deno.land/x/slack_socket_mode@1.0.0/mod.ts" + +const appToken = Deno.env.get("SLACK_APP_TOKEN") +const socketModeClient = new SocketModeClient({ appToken }) + +// Attach listeners to events by type. See: https://api.slack.com/events/message +socketModeClient.addEventListener("message", ({ detail: { body, ack } }) => { + ack() + console.log(body) +}) + +await socketModeClient.start() +``` + +## API + +- API is similar to the [node @slack/socket-mode](https://www.npmjs.com/package/@slack/socket-mode), where `.addEventListener` is used instead of `.on` ([EventTarget docs](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget)) +- Complete [generated docs](https://doc.deno.land/https/deno.land/x/slack_socket_mode@1.0.0/mod.ts) are also available + +## Supporters + +[![Stargazers repo roster for @slack-deno/socket-mode](https://reporoster.com/stars/slack-deno/socket-mode)](https://github.com/slack-deno/socket-mode/stargazers) + +[![Forkers repo roster for @slack-deno/socket-mode](https://reporoster.com/forks/slack-deno/socket-mode)](https://github.com/slack-deno/socket-mode/network/members) + +## Related + +- [Deno modules](https://github.com/KhushrajRathod/DenoModules) diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 0000000..1e0e75c --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file