Skip to content

Commit

Permalink
move readme back to project root
Browse files Browse the repository at this point in the history
  • Loading branch information
Filip Maj committed Jun 12, 2024
1 parent 29ba701 commit 20990bf
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 41 deletions.
1 change: 0 additions & 1 deletion README.md

This file was deleted.

40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# deno-slack-protocols

[![codecov](https://codecov.io/gh/slackapi/deno-slack-protocols/graph/badge.svg?token=SR0MMXTQRW)](https://codecov.io/gh/slackapi/deno-slack-protocols)

This library is a utility for use by Slack's next-generation application
platform, focused on remixable units of functionality encapsulated as ephemeral
functions. It implements the rules for communication (i.e. the protocol) between
[Slack CLI][cli] and any Slack app development SDKs.

This is separate from the [deno-slack-hooks][hooks] project, which implements
the various APIs encapsulating work delegation from the CLI to the SDK. The
[deno-slack-hooks][hooks] project implements the API, which uses this library
under the hood.

## Requirements

This library requires a recent (at least 1.22) version of
[deno](https://deno.land).

## 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-protocols/blob/main/.github/CONTRIBUTING.md)
for how to contribute in a helpful and collaborative way.

[cli]: https://github.com/slackapi/slack-cli
[hooks]: https://github.com/slackapi/deno-slack-hooks
40 changes: 0 additions & 40 deletions src/README.md

This file was deleted.

0 comments on commit 20990bf

Please sign in to comment.