diff --git a/package.json b/package.json index ca0873a..e1962ff 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "miniseed", - "version": "0.1.3", + "version": "0.1.4", "type": "module", "scripts": { "build": "vite build", diff --git a/readme.md b/readme.md index 73c13fa..c70d40a 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ # miniSEED-ts -miniSEED-ts is a Typescript implementation of the miniSEED binary format. +miniSEED-ts is a Typescript implementation of the miniSEED V3 binary format. You can [read more about miniSEED here](https://docs.fdsn.org/projects/miniseed3/en/latest/index.html). @@ -60,15 +60,13 @@ console.log(serialiseToMiniSEEDBuffer(data, metadata)); // ArrayBuffer ## Notes -- Only miniSEED version 3 is supported +- Only miniSEED version 3 is supported. Use [mseedconvert](https://github.com/EarthScope/mseedconvert) to convert between V2 and V3. - Currently, only serialisation is supported. Deserialisation is planned - The various compression options offered by miniSEED aren't currently supported ### Why not Streams -I wish I could use streams for this. Unfortunately, miniSEED requires setting the body length in one of the headers. This means we can't start generating the response until we have all the data for the body. - -We could try and estimate the body length though. E.g. if you want to stream the result of a huge database query as miniSEED, you could first do a `SELECT COUNT(*) ...` before the actual query, and use that, plus the encoding size to estimate the length of the body, thereby allowing you to stream the generated miniSEED data. I may look into doing something like this in the future. +I wish I could use streams for this. Unfortunately, miniSEED requires a CRC hash of the whole record to be set in the headers. This means we can't start generating the response until we have all the data for the body. ## Contributing