From 3367b783fd859b58ce4c8592865f2de6553a52fb Mon Sep 17 00:00:00 2001 From: William Bergamin Date: Mon, 8 Jan 2024 12:30:47 -0500 Subject: [PATCH] add simbolic link to readme (#4) --- README.md | 39 +-------------------------------------- src/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 38 deletions(-) mode change 100644 => 120000 README.md create mode 100644 src/README.md diff --git a/README.md b/README.md deleted file mode 100644 index 27a15df..0000000 --- a/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# 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](.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 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..512d13a --- /dev/null +++ b/src/README.md @@ -0,0 +1,38 @@ +# 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