clean up for 0.1.0 publish

README.md

@@ -1,26 +1,38 @@
 # payload dumper
-Script tested on Yandex Amber OTA's (full and incremental) under Linux(but may works on Windows too)
 
-## System requirement
+Dumps the `payload.bin` image found in Android update images.
 
-- Python3, pip
-- google protobuf for python `pip install protobuf`
+## Installation
 
-## Guide
+### Requirements
 
-- Make you sure you have Python 3.6 installed.
-- Download payload_dumper.py and update_metadata_pb2.py
-- Extract your OTA zip and place payload.bin in the same folder as these files.
-- Open PowerShell, Command Prompt, or Terminal depending on your OS.
-- Enter the following command: python -m pip install protobuf
+- Python3
+- pip
 
-### Full OTA
+### Install using pip
 
-- When that’s finished, enter this command: python payload_dumper.py payload.bin
-- This will start to extract the images within the payload.bin file to the output folder you are in.
+```sh
+pip install --user payload_dumper
+```
 
-### Incremental OTA
+## Usage
 
-- Copy original images (from full OTA or dumped from devices) to old folder (with part name + .img, ex: boot.img, system.img)
-- run python payload_dumper.py --diff payload.bin
-- file extracted to the output folder you are in.
+### Dumping the entirety of `payload.bin`
+
+```
+payload_dumper payload.bin
+```
+
+### Dumping specific partitions
+
+Use a comma-separated list of partitions to dump:
+```
+payload_dumper --partitions boot,dtbo,vendor
+```
+
+### Patching older image with OTA
+
+Assuming the old partitions are in a directory named `old/`:
+```
+payload_dumper --diff payload.bin
+```