summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMason Reed <mason@vector35.com>2024-05-22 20:06:24 -0400
committerMason Reed <mason@vector35.com>2024-05-22 20:22:44 -0400
commitdff192e3bd6d5737633a740988c31e4ecba92998 (patch)
tree39dfd844e8c35c0af37e917f97abeabf568c8d72 /README.md
parent331d226464fb043a12eada4f4c752d8ef20c5efb (diff)
Add background task example plugin
Clarify BackgroundTask functionality (skip-note, skip-ci) Providing clear documentation so it is understood that background tasks do not manage the execution of said the task. Add background_task plugin to examples section
Diffstat (limited to 'README.md')
-rw-r--r--README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2d35380a..b0c0caa1 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,7 @@ In addition to the default build setup, you may want to:
There are many examples available. The [Python examples folder](https://github.com/Vector35/binaryninja-api/tree/dev/python/examples) demonstrates many different applications of the Python API, while C++ examples include:
+- [background_task](https://github.com/Vector35/binaryninja-api/tree/dev/examples/background_task) is a plugin that demonstrates managing a background task.\*
- [bin-info](https://github.com/Vector35/binaryninja-api/tree/dev/examples/bin-info) is a standalone executable that prints some information about a given binary to the terminal.\*
- [breakpoint](https://github.com/Vector35/binaryninja-api/tree/dev/examples/breakpoint) is a plugin that allows you to select a region within an x86 binary and use the context menu to fill it with breakpoint bytes.
- [command-line disassm](https://github.com/Vector35/binaryninja-api/tree/dev/examples/cmdline_disasm) demonstrates how to dump disassembly to the command line.\*