summaryrefslogtreecommitdiff
path: root/python/examples/snippets/README.md
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2020-09-02 14:18:07 -0400
committerJordan Wiens <jordan@psifertex.com>2020-09-02 14:18:07 -0400
commitc1b11a0085c780ac3d5e3400a31ad939b376ede3 (patch)
tree1b2c3f2cfebd5c9f1b23a44b8365a89f9363dcf6 /python/examples/snippets/README.md
parent67db6cfda9647c0f384337e9f8f6702c1abb3210 (diff)
update snippets from latest plugin
Diffstat (limited to 'python/examples/snippets/README.md')
-rw-r--r--python/examples/snippets/README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/python/examples/snippets/README.md b/python/examples/snippets/README.md
index f2b24889..00274c3a 100644
--- a/python/examples/snippets/README.md
+++ b/python/examples/snippets/README.md
@@ -1,18 +1,17 @@
-# Snippet UI Plugin (v1.1)
+# Snippet UI Plugin (v1.5)
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**
+_Powerful code-editing plugin for writing and managing python code-snippets with syntax highlightingd, hotkey binding and other features_
+
+## Description:
-_Example UI plugin demonstrating how to create a snippet manager that allows for quick one-liners to be bound to hotkeys._
+The snippet editor started as a simple example UI plugin to demonstrate new features available to UI plugins. It has turned into a functionally useful plugin in its own right. The snippet editor allows you to write small bits of code that might not be big enough to warrant the effort of a full plugin but are longer enough that you don't want to retype them every time in the python-console!
-![](./media/snippets.gif)
+As an added bonus, all snippets are added to the snippets menu and hot-keys can be associated with them as they make use of the action system. All action-system items are also available through the command-palette (CTL/CMD-p).
-## Description:
+![](https://github.com/Vector35/snippets/blob/master/media/snippets.gif?raw=true)
-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
@@ -28,11 +27,12 @@ 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:
- * 1401
+* 1528