Skip to content

Commit

Permalink
README.md: reformat
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
kfish committed Mar 14, 2012
1 parent 444bba8 commit 24e835f
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions 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

0 comments on commit 24e835f

Please sign in to comment.