From 0c699e10bef146ee0c21eaef8752f22f4e7b42d9 Mon Sep 17 00:00:00 2001 From: TheTechromancer Date: Mon, 23 Oct 2023 22:20:37 -0400 Subject: [PATCH 1/3] update docs --- README.md | 8 ++++++-- docs/dev/index.md | 2 ++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c8ff90f5..203e4c394 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,9 @@ For details, see [Configuration](https://www.blacklanternsecurity.com/bbot/scann ## BBOT as a Python library -BBOT exposes a Python API that allows it to be used for all kinds of fun and nefarious purposes, like a [Discord Bot that responds to `/scan evilcorp.com`](https://www.blacklanternsecurity.com/bbot/dev/#bbot-python-library-advanced-usage#discord-bot-example). +BBOT exposes a Python API that allows it to be used for all kinds of fun and nefarious purposes, like a [Discord Bot](https://www.blacklanternsecurity.com/bbot/dev/#bbot-python-library-advanced-usage#discord-bot-example) that responds to the `/scan` command. + +![![bbot-discord](https://github.com/blacklanternsecurity/bbot/assets/20261699/22b268a2-0dfd-4c2a-b7c5-548c0f2cc6f9)](https://www.blacklanternsecurity.com/bbot/dev/#bbot-python-library-advanced-usage#discord-bot-example) **Synchronous** @@ -167,7 +169,9 @@ asyncio.run(main()) - [Troubleshooting](https://www.blacklanternsecurity.com/bbot/troubleshooting) -## Acknowledgements +## Contribution + +Collaboration is what makes BBOT great. We welcome contributions - and not just in the form of code, but ideas, too! If you have an idea for a new feature, please let us know in [Discussions](https://github.com/blacklanternsecurity/bbot/discussions). If you want to get your hands dirty, see [Contribution](https://www.blacklanternsecurity.com/bbot/contribution/). There you can find setup instructions and a simple tutorial on how to write a BBOT module. We also have extensive [Developer Documentation](https://www.blacklanternsecurity.com/bbot/dev/). Thanks to these amazing people for contributing to BBOT! :heart: diff --git a/docs/dev/index.md b/docs/dev/index.md index 5a9bf88d0..093a3aefb 100644 --- a/docs/dev/index.md +++ b/docs/dev/index.md @@ -6,6 +6,8 @@ Documented in this section are commonly-used classes and functions within BBOT, ## Discord Bot Example +![bbot-discord](https://github.com/blacklanternsecurity/bbot/assets/20261699/22b268a2-0dfd-4c2a-b7c5-548c0f2cc6f9) + Below is a simple Discord bot designed to run BBOT scans. ```python From 560c899c27c6728f368a172a5ffc460ccafb2391 Mon Sep 17 00:00:00 2001 From: TheTechromancer Date: Mon, 23 Oct 2023 22:26:39 -0400 Subject: [PATCH 2/3] fix readme gif --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 203e4c394..4e040ae42 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ For details, see [Configuration](https://www.blacklanternsecurity.com/bbot/scann BBOT exposes a Python API that allows it to be used for all kinds of fun and nefarious purposes, like a [Discord Bot](https://www.blacklanternsecurity.com/bbot/dev/#bbot-python-library-advanced-usage#discord-bot-example) that responds to the `/scan` command. -![![bbot-discord](https://github.com/blacklanternsecurity/bbot/assets/20261699/22b268a2-0dfd-4c2a-b7c5-548c0f2cc6f9)](https://www.blacklanternsecurity.com/bbot/dev/#bbot-python-library-advanced-usage#discord-bot-example) +![bbot-discord](https://github.com/blacklanternsecurity/bbot/assets/20261699/22b268a2-0dfd-4c2a-b7c5-548c0f2cc6f9) **Synchronous** From ffc4a188467e4fa4874fd54c5985821543403887 Mon Sep 17 00:00:00 2001 From: TheTechromancer Date: Mon, 23 Oct 2023 22:31:09 -0400 Subject: [PATCH 3/3] update README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4e040ae42..5d781e6aa 100644 --- a/README.md +++ b/README.md @@ -171,11 +171,11 @@ asyncio.run(main()) ## Contribution -Collaboration is what makes BBOT great. We welcome contributions - and not just in the form of code, but ideas, too! If you have an idea for a new feature, please let us know in [Discussions](https://github.com/blacklanternsecurity/bbot/discussions). If you want to get your hands dirty, see [Contribution](https://www.blacklanternsecurity.com/bbot/contribution/). There you can find setup instructions and a simple tutorial on how to write a BBOT module. We also have extensive [Developer Documentation](https://www.blacklanternsecurity.com/bbot/dev/). +BBOT is constantly being improved by the community. Every day it grows more powerful! -Thanks to these amazing people for contributing to BBOT! :heart: +We welcome contributions. Not just code, but ideas too! If you have an idea for a new feature, please let us know in [Discussions](https://github.com/blacklanternsecurity/bbot/discussions). If you want to get your hands dirty, see [Contribution](https://www.blacklanternsecurity.com/bbot/contribution/). There you can find setup instructions and a simple tutorial on how to write a BBOT module. We also have extensive [Developer Documentation](https://www.blacklanternsecurity.com/bbot/dev/). -If you're interested in contributing to BBOT, or just curious how it works under the hood, see [Contribution](https://www.blacklanternsecurity.com/bbot/contribution/). +Thanks to these amazing people for contributing to BBOT! :heart: