Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

README.md: reformat

[ci skip]
  • Loading branch information...
commit 24e835fe640ade6a768253b7adc5e88d3719c81a 1 parent 444bba8
@kfish authored
Showing with 14 additions and 9 deletions.
  1. +14 −9 README.md
View
23 README.md
@@ -1,51 +1,56 @@
zoom-cache: A streamable, seekable, zoomable cache file format
==============================================================
-Goals
------
+These are some of the goals of the zoom-cache format:
- Writing
+Writing
+-------
* can be written to in streaming manner, with no backseeking
- Reading
+Reading
+-------
* can be read in one pass with no backseeking
* can be seeked on time-wise
* sections can be extracted
* can be read at varying zoom levels
- Data
+Data
+----
* Support multiple data types (float/double, int, bool, char)
* support multiple aggregation types for zooming (min/max, mean, rms, all/any,
text summary)
* Constant or variable bitrates streams
- Library
+Library
+-------
* Simple stream writing interface
* Simple stream reading interface
* Read seek interface
* Read set-zoom-level interface
- Tools
+Tools
+-----
* Verification
* Info
-Data Streams and Summary Streams
-
Interleaved streams
+-------------------
* Sync points
Index files
+-----------
* A documented way of generating time index files
Exploded form
+-------------
* one file per stream
Please sign in to comment.
Something went wrong with that request. Please try again.