Merge pull request #9 from trailofbits/readme-updates

Minor nitpicks with the readme

Author: computerality

README.md

@@ -1,31 +1,10 @@
 # pyevmasm
 
-pyevmasm is an assembler and disassembler library for the Ethereum Virtual Machine (EVM).
+pyevmasm is an assembler and disassembler library for the Ethereum Virtual Machine (EVM). It includes a commandline utility and a Python API.
 
-## Examples
-```
->>> from pyevmasm import instruction_table, disassemble_hex, disassemble_all, assemble_hex
->>> instruction_table[20]
-Instruction(0x14, 'EQ', 0, 2, 1, 3, 'Equality comparision.', None, 0)
->>> instruction_table['EQ']
-Instruction(0x14, 'EQ', 0, 2, 1, 3, 'Equality comparision.', None, 0)
->>> instrs = list(disassemble_all(binascii.unhexlify('608060405260043610603f57600035')))
->>> instrs.insert(1, instruction_table['JUMPI'])
->>> a = assemble_hex(instrs)
->>> a
-'0x60805760405260043610603f57600035'
->>> print(disassemble_hex(a))
-PUSH1 0x80
-JUMPI
-PUSH1 0x40
-MSTORE
-...
->>> assemble_hex('PUSH1 0x40\nMSTORE\n')
-'0x604052'
-```
+## CLI Examples with evmasm
 
-## evmasm
-`evmasm` is a commandline utility that uses pyevmasm to assemble or disassemble EVM.
+`evmasm` is a commandline utility that uses pyevmasm to assemble or disassemble EVM:
 
 ```
 usage: evmasm [-h] (-a | -d | -t) [-bi] [-bo] [-i [INPUT]] [-o [OUTPUT]]
@@ -46,8 +25,8 @@ optional arguments:
                         Output file, default=stdout
 ```
 
+Disassembling the preamble of compiled contract:
 
-Example; disassembling the preamble of compiled contract.
 ```
 $ echo -n "608060405260043610603f57600035" | evmasm -d
 00000000: PUSH1 0x80
@@ -62,6 +41,29 @@ $ echo -n "608060405260043610603f57600035" | evmasm -d
 0000000e: CALLDATALOAD
 ```
 
+## Python API Examples
+
+```
+>>> from pyevmasm import instruction_table, disassemble_hex, disassemble_all, assemble_hex
+>>> instruction_table[20]
+Instruction(0x14, 'EQ', 0, 2, 1, 3, 'Equality comparision.', None, 0)
+>>> instruction_table['EQ']
+Instruction(0x14, 'EQ', 0, 2, 1, 3, 'Equality comparision.', None, 0)
+>>> instrs = list(disassemble_all(binascii.unhexlify('608060405260043610603f57600035')))
+>>> instrs.insert(1, instruction_table['JUMPI'])
+>>> a = assemble_hex(instrs)
+>>> a
+'0x60805760405260043610603f57600035'
+>>> print(disassemble_hex(a))
+PUSH1 0x80
+JUMPI
+PUSH1 0x40
+MSTORE
+...
+>>> assemble_hex('PUSH1 0x40\nMSTORE\n')
+'0x604052'
+```
+
 # Installation
 
 Python >=2.7 or Python >=3.3 is required.
@@ -71,14 +73,15 @@ Install the latest stable version using pip:
 pip install pyevmasm
 ```
 
-To install the library from source:
+Or, install the library from source:
 ```
 git clone https://github.com/trailofbits/pyevmasm
 cd pyevmasm
 python setup.py install
 ```
 
 ## Documentation
+
 [https://pyevmasm.readthedocs.io](https://pyevmasm.readthedocs.io)
 
 New issues, feature requests, and contributions are welcome. Join us in #ethereum channel on the [Empire Hacking Slack](https://empireslacking.herokuapp.com) to discuss Ethereum security tool development.