Skip to content

Commit

Permalink
update descriptions for initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
psifertex committed Feb 12, 2024
1 parent 21f146c commit 0e631cd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Sample Plugin
# COMpanion
Author: **Vector 35 Inc**

_This is a short description meant to fit on one line._
_Helper plugin for handling Microsoft COM files._

## Description:
This is a longer description meant for a sample plugin that demonstrates the metadata format for Binary Ninja plugins. Note that the [community-plugins repo](https://github.com/Vector35/community-plugins) contains a useful [utility](https://github.com/Vector35/community-plugins/blob/master/generate_plugininfo.py) to validate the plugin.json. Additionally, the [release helper](https://github.com/Vector35/release_helper) plugin is helpful for more easily pushing new releases, incrementing versions, and creating the appropriate GitHub tags.

Note that originally we recommended specifying the contents of this entire file inside of the [plugin.json](./plugin.json) but the latest repository generator will use the readme contents directly which means you should simply leave an empty longdescription field.
Finds references to CoCreateInstance, CoGetClassObject, AccessibleObjectFromWindow, and CreateStdAccessibleObject and creates the appropriate COM GUID parameters including type information.

## License

Expand Down
3 changes: 1 addition & 2 deletions plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
"python3"
],
"description": "COMpanion is a plugin for Binary Ninja helps automate working with COM objects in Windows binaries.",
"longdescription": "",
"license": {
"name": "MIT",
"text": "Copyright (c) 2024 Vector 35\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
Expand All @@ -20,5 +19,5 @@
],
"version": "0.1.0",
"author": "Vector 35 Inc",
"minimumbinaryninjaversion": 3164
"minimumbinaryninjaversion": 4860
}

0 comments on commit 0e631cd

Please sign in to comment.