From b8b11ed3075826dada6b0e83e46e3190653d903f Mon Sep 17 00:00:00 2001 From: makao Date: Wed, 29 Jan 2020 22:36:01 +0100 Subject: [PATCH] NPM publishing adjustments --- README.md | 17 +++++++++++++---- package.json | 2 +- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 951fb2f..32f47df 100644 --- a/README.md +++ b/README.md @@ -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); // ``` -#### 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/) diff --git a/package.json b/package.json index f1402fd..5faaa7a 100644 --- a/package.json +++ b/package.json @@ -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",