Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Commit

Permalink
clarify package name, description, and install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jordaaash committed Dec 14, 2021
1 parent dd2e769 commit a1e15b1
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# @solana/buffer-layout

`@solana/buffer-layout` is a TypeScript fork of `buffer-layout`. Same API, just adds types and TypeScript docs.

## Installation

Install with `npm install @solana/buffer-layout`.

Development and testing is done using Node.js, supporting versions 5.10
and later.

# buffer-layout

[![NPM version](https://img.shields.io/npm/v/buffer-layout.svg)](https://www.npmjs.com/package/buffer-layout "View this project on NPM")
Expand Down Expand Up @@ -26,11 +37,6 @@ Layout support is provided for these types of data:
* NUL-terminated C strings;
* Blobs of fixed or variable-length raw data.

## Installation

Development and testing is done using Node.js, supporting versions 4.5
and later. Install with `npm install buffer-layout`.

## Examples

All examples are from the `test/examples.js` unit test and assume the
Expand Down

0 comments on commit a1e15b1

Please sign in to comment.