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

Commit a1e15b1

Browse files
committed
clarify package name, description, and install instructions
1 parent dd2e769 commit a1e15b1

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
# @solana/buffer-layout
2+
3+
`@solana/buffer-layout` is a TypeScript fork of `buffer-layout`. Same API, just adds types and TypeScript docs.
4+
5+
## Installation
6+
7+
Install with `npm install @solana/buffer-layout`.
8+
9+
Development and testing is done using Node.js, supporting versions 5.10
10+
and later.
11+
112
# buffer-layout
213

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

29-
## Installation
30-
31-
Development and testing is done using Node.js, supporting versions 4.5
32-
and later. Install with `npm install buffer-layout`.
33-
3440
## Examples
3541

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

0 commit comments

Comments
 (0)