From: Jonathan Dieter <jdieter@gmail.com>
Date: Wed, 16 May 2018 07:56:48 +0000 (+0300)
Subject: Update README.md
X-Git-Tag: archive/raspbian/1.1.9+ds1-1+rpi1~1^2~278
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=a2fd77ef1b6df7cd5c4091c828c29ba0e554b26f;p=zchunk.git

Update README.md

Signed-off-by: Jonathan Dieter <jdieter@gmail.com>
---

diff --git a/README.md b/README.md
index 9d858a9..beee592 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,46 @@
 # zchunk
 
-This project is being rapidly developed and the API is still in flux.  This is
-*not* stable code.
+zchunk is a compressed file format that splits the file into independent chunks.
+This allows you to only download changed chunks when downloading a new version
+of the file, and also makes zchunk files efficient over rsync.
+
+zchunk files are protected with strong checksums to verify that the file you
+downloaded is, in fact, the file you wanted.
+
+**Please note that, while the code is pretty reliable and the file format
+shouldn't see any further changes, the API is still not fixed.  Please do not
+use zchunk for any mission-critical systems yet.**
+
+
+##Installation
+To build and install zchunk, first install meson and run
+```
+meson build
+cd build
+ninja
+sudo ninja install
+```
+
+##Using the utilities
+To decompress a zchunk file, simply run:
+```
+unzck <filename>
+```
+
+To compress a new zchunk file, run:
+```
+zck <filename>
+```
+
+To download a zchunk file, run:
+```
+zckdl -s <source> <url of target>
+```
+
+To read a zchunk header, run:
+```
+zck_read_header <file>
+```
+
+##C API
+\#TODO