summaryrefslogtreecommitdiff
path: root/python/examples/snippets/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'python/examples/snippets/README.md')
-rw-r--r--python/examples/snippets/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/python/examples/snippets/README.md b/python/examples/snippets/README.md
new file mode 100644
index 00000000..4e62c93d
--- /dev/null
+++ b/python/examples/snippets/README.md
@@ -0,0 +1,22 @@
+# 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._
+## 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.
+## Minimum Version
+
+This plugin requires the following minimum version of Binary Ninja:
+
+ * release - 1401
+ * dev - 1.2.0
+
+
+## Required Dependencies
+
+The following dependencies are required for this plugin:
+
+
+
+## License
+This plugin is released under a [MIT](LICENSE) license.
+