summaryrefslogtreecommitdiff
path: root/python/examples
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2016-05-15 20:56:39 -0400
committerJordan Wiens <jordan@psifertex.com>2016-05-15 20:56:39 -0400
commitfc6873c2b34ff8df7c0cf4947d95a553d6f7d72c (patch)
tree4b3187ff5fff44fc8b648930de856ad976003de2 /python/examples
parent8bafa835a3f86b3db50ecf2675ba872b58adff58 (diff)
updated readme
Diffstat (limited to 'python/examples')
-rw-r--r--python/examples/README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/python/examples/README.md b/python/examples/README.md
index 4ad4ac03..7fd3ab6b 100644
--- a/python/examples/README.md
+++ b/python/examples/README.md
@@ -1,11 +1,12 @@
# Binary Ninja Python API Examples
-The following examples demonstrate the Binary Ninja API. They include both stand-alone examples that directly call into the core, as well as examples meant to be loaded as plugins.
+The following examples demonstrate some of the Binary Ninja API. They include both stand-alone examples that directly call into the core without a GUI, as well as examples meant to be loaded as plugins available from the UI.
## Stand-alone
* bin-info.py - general binary information
* arm-syscall.py - extract syscall numbers from IL for arm Mach-O files
+* version-switcher.py - uses the update API to see raw version notes and manually downgrade or upgrade
To use the stand-alone Python examples, make sure your `PYTHON_PATH` includes the API, like:
@@ -17,6 +18,7 @@ PYTHONPATH=$PYTHONPATH:/Applications/Binary\ Ninja.app/Contents/Resources/python
* nes.py - 6502 CPU architecture including LLIL lifting and `.NES` file format parser
* breakpoint.py - small example showing how to modify a file and register a GUI menu item
+* jump-table.py - stop-gap jump table plugin triggered via right-click menu at an indirect jump
Plugins are meant to be loaded into a running Binary Ninja GUI and should either be copied or symlinked into the appropriate plugin folder. You'll need to then re-start Binary Ninja.