Skip to content

Commit

Permalink
NPM publishing adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
makao committed Jan 29, 2020
1 parent f3ff433 commit b8b11ed
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,31 @@
# LFS pack

JavaScript library used for packing and unpacking [LFS](https://lfs.net) [InSim](https://en.lfsmanual.net/wiki/InSim) packets

[![Build Status](https://travis-ci.com/makao/lfs-pack.svg?branch=master)](https://travis-ci.com/makao/lfs-pack)
[![Coverage Status](https://coveralls.io/repos/github/makao/lfs-pack/badge.svg?branch=master)](https://coveralls.io/github/makao/lfs-pack?branch=master)

JavaScript library used for packing and unpacking LFS packets
## Installation

```bash
npm install --save @makao.pl/lfs-pack
```

## Example
## Usage

#### Pack
__Pack__
```javascript
// packing 4 unsigned chars into buffer
const buffer = pack('CCCC', [10, 20, 30, 40]);
console.log(buffer); // <Buffer 0a 14 1e 28>
```

#### Unpack
__Unpack__
```javascript
// unpacking 4 unsigned chars from buffer
const values = unpack('CCCC', Buffer.alloc(4));
console.log(values); // [0, 0, 0, 0]
```

## License
[MIT](https://choosealicense.com/licenses/mit/)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@makao/lfs-pack",
"name": "@makao.pl/lfs-pack",
"version": "1.0.0",
"description": "Library used for packing and unpacking LFS packets",
"main": "index.js",
Expand Down

0 comments on commit b8b11ed

Please sign in to comment.