diff --git a/README.md b/README.md index ea87a5f..1076a92 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Share Chat — Agent Zero Plugin + + +[![plugin-e2e](https://github.com/agent-zero-plugins/agent-zero-plugin-share-chat/actions/workflows/plugin-e2e.yml/badge.svg?branch=main)](https://github.com/agent-zero-plugins/agent-zero-plugin-share-chat/actions/workflows/plugin-e2e.yml) [![BDD scenarios](https://img.shields.io/badge/tests-BDD%20e2e-brightgreen)](https://github.com/agent-zero-plugins/agent-zero-plugin-share-chat/tree/main/tests/e2e/features) [![Release](https://img.shields.io/github/v/tag/agent-zero-plugins/agent-zero-plugin-share-chat?label=release&sort=semver)](https://github.com/agent-zero-plugins/agent-zero-plugin-share-chat/tags) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/agent-zero-plugins/agent-zero-plugin-share-chat/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/agent-zero-plugins/agent-zero-plugin-share-chat/blob/main/CONTRIBUTING.md) + + + [![plugin-e2e](https://github.com/agent-zero-plugins/agent-zero-plugin-share-chat/actions/workflows/plugin-e2e.yml/badge.svg)](https://github.com/agent-zero-plugins/agent-zero-plugin-share-chat/actions/workflows/plugin-e2e.yml) License: [Apache-2.0](LICENSE) @@ -114,4 +120,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for the workflow. ## License -[Apache-2.0](LICENSE) © Interu +[Apache-2.0](LICENSE) © Interu \ No newline at end of file diff --git a/docs/BEHAVIOUR.md b/docs/BEHAVIOUR.md new file mode 100644 index 0000000..cb8e77e --- /dev/null +++ b/docs/BEHAVIOUR.md @@ -0,0 +1,26 @@ +# Share Chat — behaviour + + + +Each section is one scenario from `tests/e2e/features/`, with the screenshot the +test captured at its final assertion. 3 of 3 scenarios have one. + +## Sharing a chat via a deep link + +### The share control is present in the chat +BEH-1 + +![The share control is present in the chat](screenshots/the-share-control-is-present-in-the-chat.png) + +### Sharing copies a link to this chat +BEH-4, BEH-5 + +![Sharing copies a link to this chat](screenshots/sharing-copies-a-link-to-this-chat.png) + +### Sharing confirms the link was copied +BEH-7 + +![Sharing confirms the link was copied](screenshots/sharing-confirms-the-link-was-copied.png) diff --git a/docs/screenshots/sharing-confirms-the-link-was-copied.png b/docs/screenshots/sharing-confirms-the-link-was-copied.png new file mode 100644 index 0000000..b7af43a Binary files /dev/null and b/docs/screenshots/sharing-confirms-the-link-was-copied.png differ diff --git a/docs/screenshots/sharing-copies-a-link-to-this-chat.png b/docs/screenshots/sharing-copies-a-link-to-this-chat.png new file mode 100644 index 0000000..99f764d Binary files /dev/null and b/docs/screenshots/sharing-copies-a-link-to-this-chat.png differ diff --git a/docs/screenshots/the-share-control-is-present-in-the-chat.png b/docs/screenshots/the-share-control-is-present-in-the-chat.png new file mode 100644 index 0000000..882e3b5 Binary files /dev/null and b/docs/screenshots/the-share-control-is-present-in-the-chat.png differ