Skip to content

Commit

Permalink
make readme symbolic link (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
WilliamBergamin authored Jan 8, 2024
1 parent 7476afc commit 43269f5
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 59 deletions.
59 changes: 0 additions & 59 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
59 changes: 59 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# deno-slack-api

Slack API Client for Deno Run on Slack projects

```ts
import { SlackAPI } from "https://deno.land/x/[email protected]/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.

0 comments on commit 43269f5

Please sign in to comment.