summaryrefslogtreecommitdiff
path: root/python/examples/snippets/README.md
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2020-03-02 08:24:01 -0500
committerJordan Wiens <jordan@psifertex.com>2020-03-02 08:24:01 -0500
commitcbdd08653c09ff2675e0c33efff81a62e4655d7c (patch)
treef0da67dd2fec95d25d2cbe2f189b0c0133f836ee /python/examples/snippets/README.md
parenta54caeeacdad4c3209301e114a6acb5312d92c28 (diff)
small updates to snippets from upstream
Diffstat (limited to 'python/examples/snippets/README.md')
-rw-r--r--python/examples/snippets/README.md34
1 files changed, 31 insertions, 3 deletions
diff --git a/python/examples/snippets/README.md b/python/examples/snippets/README.md
index 4e62c93d..f2b24889 100644
--- a/python/examples/snippets/README.md
+++ b/python/examples/snippets/README.md
@@ -1,14 +1,39 @@
+# Snippet UI Plugin (v1.1)
+Author: **Vector 35 Inc**
+_Example UI plugin demonstrating how to create a snippet manager that allows for quick one-liners to be bound to hotkeys._
+## Description:
# Snippet UI Plugin (v1.0 alpha)
+
Author: **Vector 35 Inc**
+
_Example UI plugin demonstrating how to create a snippet manager that allows for quick one-liners to be bound to hotkeys._
+
+![](./media/snippets.gif)
+
## Description:
+
This plugin is dual purpose -- first, it demonstrates the new UI plugin interface available for third-party plugins, and secondly it implements the often-requested functionality of adding a snippet editor. This is particularly useful for binding commonly used snippets of python code from the ScriptingConsole to a hotkey to be able to trigger them more easily.
+
+
+## Installation Instructions
+
+### Darwin
+
+no special instructions, package manager is recommended
+
+### Linux
+
+no special instructions, package manager is recommended
+
+### Windows
+
+no special instructions, package manager is recommended
## Minimum Version
This plugin requires the following minimum version of Binary Ninja:
- * release - 1401
- * dev - 1.2.0
+ * 1401
+
## Required Dependencies
@@ -18,5 +43,8 @@ The following dependencies are required for this plugin:
## License
-This plugin is released under a [MIT](LICENSE) license.
+This plugin is released under a MIT license.
+## Metadata Version
+
+2