diff --git a/README.md b/README.md deleted file mode 100644 index 8457b68..0000000 --- a/README.md +++ /dev/null @@ -1,59 +0,0 @@ -# deno-slack-api - -Slack API Client for Deno Run on Slack projects - -```ts -import { SlackAPI } from "https://deno.land/x/deno_slack_api@2.1.1/mod.ts"; - -const client = SlackAPI(token); - -// ...or create a client with options -const client = SlackAPI(token, { - slackApiUrl: "...", -}); - -await client.chat.postMessage({ - text: "hello there", - channel: "...", -}); - -// respond to a response_url -await client.response("...", payload); - -// use apiCall() w/ method name -await client.apiCall("chat.postMessage", { - text: "hello there", - channel: "...", -}); -``` - -## Requirements - -A recent version of `deno`. - -## Versioning - -Releases for this repository follow the [SemVer](https://semver.org/) versioning -scheme. The SDK's contract is determined by the top-level exports from -`src/mod.ts` and `src/types.ts`. Exports not included in these files are deemed -internal and any modifications will not be treated as breaking changes. As such, -internal exports should be treated as unstable and used at your own risk. - -## Running Tests - -If you make changes to this repo, or just want to make sure things are working -as desired, you can run: - - deno task test - -To get a full test coverage report, run: - - deno task coverage - ---- - -### Getting Help - -We welcome contributions from everyone! Please check out our -[Contributor's Guide](.github/CONTRIBUTING.md) for how to contribute in a -helpful and collaborative way. diff --git a/README.md b/README.md new file mode 120000 index 0000000..351df1d --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +src/README.md \ No newline at end of file diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..4b823f1 --- /dev/null +++ b/src/README.md @@ -0,0 +1,59 @@ +# deno-slack-api + +Slack API Client for Deno Run on Slack projects + +```ts +import { SlackAPI } from "https://deno.land/x/deno_slack_api@2.1.1/mod.ts"; + +const client = SlackAPI(token); + +// ...or create a client with options +const client = SlackAPI(token, { + slackApiUrl: "...", +}); + +await client.chat.postMessage({ + text: "hello there", + channel: "...", +}); + +// respond to a response_url +await client.response("...", payload); + +// use apiCall() w/ method name +await client.apiCall("chat.postMessage", { + text: "hello there", + channel: "...", +}); +``` + +## Requirements + +A recent version of `deno`. + +## Versioning + +Releases for this repository follow the [SemVer](https://semver.org/) versioning +scheme. The SDK's contract is determined by the top-level exports from +`src/mod.ts` and `src/types.ts`. Exports not included in these files are deemed +internal and any modifications will not be treated as breaking changes. As such, +internal exports should be treated as unstable and used at your own risk. + +## Running Tests + +If you make changes to this repo, or just want to make sure things are working +as desired, you can run: + + deno task test + +To get a full test coverage report, run: + + deno task coverage + +--- + +### Getting Help + +We welcome contributions from everyone! Please check out our +[Contributor's Guide](https://github.com/slackapi/deno-slack-api/blob/main/.github/CONTRIBUTING.md) +for how to contribute in a helpful and collaborative way.