sigfile/README.md

Utilities to reading signal data from files

SigFile
======================

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Build Status](https://travis-ci.org/LGSInnovations/sigfile.svg?branch=master)](https://travis-ci.org/LGSInnovations/sigfile) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](.github/CONTRIBUTING.md#pull-requests) [![npm version](https://badge.fury.io/js/sigfile.svg)](https://badge.fury.io/js/sigfile) [![codecov](https://codecov.io/gh/LGSInnovations/sigfile/branch/master/graph/badge.svg)](https://codecov.io/gh/LGSInnovations/sigfile)

SigFile provides MATLAB file parsing and XMIDAS Bluefile parsing in JS.

## Installation

```
npm i sigfile
```

or

```
yarn add sigfile
```

## Example

### Extracting the header from a Bluefile

```javascript
const sigfile = require('sigfile');
const fs = require('fs');

fs.readFile('__tests__/dat/ramp.tmp', function(err, buf) {
    const header = new sigfile.BlueHeader(buf.buffer);
    console.log(header);
});
```

or

```javascript
import { readFile } from 'fs';
import { BlueHeader } from 'sigfile';

readFile('__tests__/dat/ramp.tmp', (err, buf) => {
    const header = new sigfile.BlueHeader(buf.buffer);
    console.log(header);
});