Updated README with GIF and usage

zznop · Jan 1, 2022 · 57b32d8 · 57b32d8
1 parent 29e1741
commit 57b32d8
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,23 @@
 # bn-kconfig-recover
 
+![demo bn-kconfig-recover](bn-kconfig-recover.gif)
+
 ## Description
 
-Binary Ninja plugin that analyzes Linux kernel binaries to automate recovery of kernel build configuration (kconfig)
-settings.
+Binary Ninja plugin that analyzes Linux kernel binaries to automate recovery of the build configuration (`.config`)
+
+## Usage
+
+```
+usage: bn_kconfig_recover.py [-h] [-d] bndb kconfig
+
+positional arguments:
+  bndb         File path to kernel ELF or Binary Ninja database
+  kconfig      File path to save recovered kernel configuration
+
+optional arguments:
+  -h, --help   show this help message and exit
+  -d, --debug  Enable debug logging
+```
+
+
diff --git a/bn-kconfig-recover.gif b/bn-kconfig-recover.gif