From 43abdeb659969f06d4b9edf681fffea49a208c9c Mon Sep 17 00:00:00 2001
From: bloodstalker <thabogre@gmail.com>
Date: Thu, 28 Jun 2018 10:27:07 +0430
Subject: update

---
 README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8db8504..5c3289d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,60 @@
 # delf
+delf is an ELF dump tool.<br/>
+
+## Requirements
+You need python3 and `capstone`. If you don't have capstone you can get it by:<br/>
+```bash
+
+pip install capstone
+
+```
+Your terminal needs to support ASCII escape sequences.<br/>
+
+## Options
+For a list of available options just run `delf -h`. Here's what you'll get:<br/>
+```bash
+
+usage: delf [-h] [--dbg] [--obj OBJ] [--header] [--symboltable] [--phdrs]
+            [--shdrs] [--symbolindex] [--stentries] [--objcode] [--test]
+            [--test2] [--funcs] [--objs] [--dynsym] [--dlpath] [--phdynent]
+            [--section SECTION] [--dumpfunc DUMPFUNC]
+            [--dumpfuncasm DUMPFUNCASM] [--textasm] [--dynsecents] [--reladyn]
+            [--relaplt] [--rodata] [--disass DISASS]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --dbg                 debug
+  --obj OBJ             path to the executbale, shared object or object you
+                        want to load in bruiser
+  --header              dump headers
+  --symboltable         dump symbol table
+  --phdrs               dump program haeders
+  --shdrs               dump section haeders
+  --symbolindex         dump symbol index
+  --stentries           dump section table entries
+  --objcode             dump objects
+  --test                test switch
+  --test2               test switch 2
+  --funcs               dump functions
+  --objs                dump objects
+  --dynsym              dump dynamic symbol table
+  --dlpath              dump dynamic linker path
+  --phdynent            dump ph PT_DYNAMIC entries
+  --section SECTION     dump a section
+  --dumpfunc DUMPFUNC   dump a functions machine code
+  --dumpfuncasm DUMPFUNCASM
+                        dump a functions assembly code
+  --textasm             disassemble the text section
+  --dynsecents          dynamic section entries
+  --reladyn             .rela.dyn entries
+  --relaplt             .rela.plt entries
+  --rodata              dump .rodata
+  --disass DISASS       disassemblt a section
+
+  ```
+
+## Feature Request
+If there is something you need delf to do, make an issue and I'll take a look.<br/>
+
+## TODO
+delf does not support ELF32. I'll write that in whenver I get the tiem to work on delf<br/>
-- 
cgit v1.2.3