Update README.md

Author: robertwayne

README.md

@@ -1,8 +1,8 @@
 # 🐡 bufferfish
 
-`bufferfish` is utility library for working with binary network messages between Rust and TypeScript, such as over WebSockets. It provides a simple API for encoding and decoding data into binary arrays, as well as generating TypeScript definitions and decoding functions from your Rust code.
+`bufferfish` is utility library for working with binary network messages between Rust and TypeScript, such as over WebSockets. It provides a simple API for encoding and decoding data into binary arrays, as well as generating TypeScript definitions and encode/decode functions from your Rust code.
 
-_This library has an unstable API and may be missing some basic functionality. I can't recommend using it in production, although I am using it for my own production project._
+_This library has an unstable API. I can't recommend using it in production, although I am using it for my own production project._
 
 ## Table of Contents
 
@@ -51,7 +51,7 @@ The TypeScript implementation lives here. The API is generally mirrored from the
 
 Use `cargo add bufferfish` to add the Rust library to your project.
 
-Use `npm install bufferfish` to add the TypeScript library to your project.
+Use `bun install bufferfish` to add the TypeScript library to your project.
 
 ## Examples
 

rust/bufferfish-core/README.md

@@ -6,10 +6,6 @@ Core types, traits, and logic implementations for [bufferfish](https://github.co
 
 See the [main project repository](https://github.com/robertwayne/bufferfish) for more details.
 
-## Contributing
-
-`bufferfish` is open to contributions, however it should be noted that the library was created for my own game projects, and I am not interested in making it widely general-purpose. If you still have a feature request or bug fix that you think would be useful to others, feel free to open an issue or PR.
-
 ## License
 
 `bufferfish` source code is dual-licensed under either

rust/bufferfish-derive/README.md

@@ -6,10 +6,6 @@ Macros for [bufferfish](https://github.com/robertwayne/bufferfish).
 
 See the [main project repository](https://github.com/robertwayne/bufferfish) for more details.
 
-## Contributing
-
-`bufferfish` is open to contributions, however it should be noted that the library was created for my own game projects, and I am not interested in making it widely general-purpose. If you still have a feature request or bug fix that you think would be useful to others, feel free to open an issue or PR.
-
 ## License
 
 `bufferfish` source code is dual-licensed under either

rust/bufferfish/README.md

@@ -2,7 +2,7 @@
 
 `bufferfish` is utility library for working with binary network messages between Rust and TypeScript, such as over WebSockets. It provides a simple API for encoding and decoding data into binary arrays, as well as generating TypeScript definitions and decoding functions from your Rust code.
 
-_This library has an unstable API and may be missing some basic functionality. I can't recommend using it in production, although I am using it for my own production project._
+_This library has an unstable API. I can't recommend using it in production, although I am using it for my own production project._
 
 # Table of Contents
 
@@ -23,7 +23,7 @@ _This library has an unstable API and may be missing some basic functionality. I
 
 Use `cargo add bufferfish` to add the Rust library to your project.
 
-Use `npm install bufferfish` to add the TypeScript library to your project.
+Use `bun install bufferfish` to add the TypeScript library to your project.
 
 ## Examples
 

typescript/README.md

@@ -4,35 +4,35 @@
 
 See the [project repository](https://github.com/robertwayne/bufferfish) for more details, including how to interop with Rust.
 
-_This library has an unstable API and may be missing some basic functionality. I can't recommend using it in production, although I am using it for my own production project._
+_This library has an unstable API. I can't recommend using it in production, although I am using it for my own production project._
 
 ## Table of Contents
 
-  - [Getting Started](#getting-started)
-  - [Examples](#examples)
+- [Getting Started](#getting-started)
+- [Examples](#examples)
     - [Writing to a Bufferfish](#writing-to-a-bufferfish)
     - [Reading from a Bufferfish](#reading-from-a-bufferfish)
-  - [TypeScript Code Generation](#typescript-code-generation)
+- [TypeScript Code Generation](#typescript-code-generation)
     - [Using Generated Decoding Functions](#using-generated-decoding-functions)
-  - [Encodable Types](#encodable-types)
-  - [Feature Flags (Rust)](#feature-flags-rust)
-  - [Notes](#notes)
-  - [Security](#security)
-  - [Contributing](#contributing)
-  - [License](#license)
+- [Encodable Types](#encodable-types)
+- [Feature Flags (Rust)](#feature-flags-rust)
+- [Notes](#notes)
+- [Security](#security)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Getting Started
 
 Use `cargo add bufferfish` to add the Rust library to your project.
 
-Use `npm install bufferfish` to add the TypeScript library to your project.
+Use `bun install bufferfish` to add the TypeScript library to your project.
 
 ## Examples
 
 ### Writing to a Bufferfish
 
 ```typescript
-import { Bufferfish } from 'bufferfish'
+import { Bufferfish } from "bufferfish"
 
 const ws = new WebSocket("ws://127.0.0.1:3000")
 ws.binaryType = "arraybuffer"
@@ -47,14 +47,14 @@ ws.send(bf.view())
 ### Reading from a Bufferfish
 
 ```typescript
-import { Bufferfish } from 'bufferfish'
+import { Bufferfish } from "bufferfish"
 
 const ws = new WebSocket("ws://127.0.0.1:3000")
 ws.binaryType = "arraybuffer"
 
 onmessage = (event) => {
-  const bf = new Bufferfish(event.data)
-  const id = bf.readUint8()
+    const bf = new Bufferfish(event.data)
+    const id = bf.readUint8()
 
     if (id === 0) {
         const message = bf.readString()
@@ -139,8 +139,8 @@ const ws = new WebSocket("ws://127.0.0.1:3000")
 ws.binaryType = "arraybuffer"
 
 ws.onmessage = (event) => {
-  const bf = new Bufferfish(event.data)
-  const packetId = bf.readUint16()
+    const bf = new Bufferfish(event.data)
+    const packetId = bf.readUint16()
 
     if (packetId === PacketId.Join) {
         const packet = decodeJoinPacket(bf)
@@ -152,27 +152,27 @@ ws.onmessage = (event) => {
 
 ## Encodable Types
 
-Supported Types             | Decodes As
---------------------------- | ---------------------
-`u8`                        | `number`
-`u16`                       | `number`
-`u32`                       | `number`
-`i8`                        | `number`
-`i16`                       | `number`
-`i32`                       | `number`
-`bool`                      | `boolean`
-`String`                    | `string`
-`Vec<T> where T: Encodable` | `Array<T>`
-`T where T: Encodable`      | `object` or primitive
-
-_*The reverse is true for decoding._
+| Supported Types             | Decodes As            |
+| --------------------------- | --------------------- |
+| `u8`                        | `number`              |
+| `u16`                       | `number`              |
+| `u32`                       | `number`              |
+| `i8`                        | `number`              |
+| `i16`                       | `number`              |
+| `i32`                       | `number`              |
+| `bool`                      | `boolean`             |
+| `String`                    | `string`              |
+| `Vec<T> where T: Encodable` | `Array<T>`            |
+| `T where T: Encodable`      | `object` or primitive |
+
+_\*The reverse is true for decoding._
 
 ## Feature Flags (Rust)
 
-Flag           | Default  | Description                                                     | Dependencies
--------------- | -------- | --------------------------------------------------------------- | ------------------------------------------------
-`pretty-print` | Disabled | Enables pretty-printing of buffer output.                       | `unicode-width`
-`derive`       | Disabled | Enables the `#[derive(Encode)]` and `#[derive(Decode)]` macros. | `syn`, `quote`, `proc-macro2`, `proc-macro-error` |
+| Flag           | Default  | Description                                                     | Dependencies                                      |
+| -------------- | -------- | --------------------------------------------------------------- | ------------------------------------------------- |
+| `pretty-print` | Disabled | Enables pretty-printing of buffer output.                       | `unicode-width`                                   |
+| `derive`       | Disabled | Enables the `#[derive(Encode)]` and `#[derive(Decode)]` macros. | `syn`, `quote`, `proc-macro2`, `proc-macro-error` |
 
 ## Notes