Create a bunch of examples.

Author: goddtriffin

README.md

@@ -2,7 +2,6 @@
 
 [![Version](https://img.shields.io/crates/v/byte-transcoder)](https://crates.io/crates/byte-transcoder)
 [![Docs](https://docs.rs/byte-transcoder/badge.svg)](https://docs.rs/byte-transcoder)
-[![License](https://img.shields.io/crates/l/byte-transcoder)](https://crates.io/crates/byte-transcoder)
 
 [![JSR](https://jsr.io/badges/@todd/byte-transcoder)](https://jsr.io/@todd/byte-transcoder)
 [![JSR Score](https://jsr.io/badges/@todd/byte-transcoder/score)](https://jsr.io/@todd/byte-transcoder)
@@ -23,7 +22,62 @@ Typescript only. Helps write `number`s as specific primitives (e.g. `u8`/`u16`/`
 
 ## Examples
 
-Read `tests/` to learn how to use!
+Read `examples/`, `tests/`, and `src-ts/**/*.test.ts` for more examples!
+
+### ByteReader
+
+#### Typescript
+
+```typescript
+type Payload = { gameId: string; joinCode: string };
+
+const bytes = new Uint8Array([
+  // <your binary data>
+]);
+const byteReader = new ByteReader(bytes);
+
+const payload: Payload = {
+  gameId: byteReader.readUuid(),
+  joinCode: byteReader.readString()
+};
+```
+
+#### Rust
+
+```rust
+struct Payload {
+    game_id: Uuid,
+    join_code: String,
+}
+
+let bytes: Vec<u8> = vec![
+  // <your binary data>
+];
+let mut byte_reader = ByteReader::new(bytes);
+
+let payload = Payload {
+  game_id: byte_reader.read_uuid()?,
+  join_code: byte_reader.read_string()?,
+}
+```
+
+### ByteWriter
+
+#### Typescript
+
+```typescript
+type Payload = { gameId: string; joinCode: string };
+const payload: Payload = {
+  gameId: "24399a6c-c4a9-4053-9b2d-4199107fb567",
+  joinCode: "12345"
+};
+
+const byteWriter = new ByteWriter();
+byteWriter.writeUuid(payload.gameId);
+byteWriter.writeString(payload.joinCode);
+
+const bytes: Uint8Array = byteWriter.getBytes();
+```
 
 ## Developers
 

examples/transcode.rs

@@ -0,0 +1,66 @@
+use byte_transcoder::{reader::ByteReader, reader_error::ByteReaderResult};
+use uuid::Uuid;
+
+#[allow(dead_code)]
+#[derive(Debug)]
+pub struct Payload {
+    game_id: Uuid,
+    join_code: String,
+    lobby: Vec<Account>,
+}
+
+#[derive(Debug)]
+pub struct Account {
+    pub account_id: Uuid,
+    pub username: String,
+}
+
+fn main() -> ByteReaderResult<()> {
+    #[rustfmt::skip]
+    let bytes: Vec<u8> = vec![
+        // Game ID (UUIDv4)
+        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
+
+        // Join Code (String)
+        4, 84, 111, 100, 100,
+
+        // Lobby size (u8)
+        2,
+
+        // Account 1
+        // (UUIDv4)
+        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
+        // (String)
+        4, 84, 111, 100, 100,
+
+        // Account 2
+        // (UUIDv4)
+        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
+        // (String)
+        4, 84, 111, 100, 100,
+    ];
+
+    let mut byte_reader: ByteReader = ByteReader::new(&bytes);
+
+    let game_id: Uuid = byte_reader.read_uuid()?;
+    let join_code: String = byte_reader.read_string()?;
+
+    let mut lobby: Vec<Account> = Vec::new();
+    let lobby_len: u8 = byte_reader.read_u8()?;
+    for _ in 0..lobby_len {
+        lobby.push(Account {
+            account_id: byte_reader.read_uuid()?,
+            username: byte_reader.read_string()?,
+        });
+    }
+
+    println!(
+        "{:?}",
+        Payload {
+            game_id,
+            join_code,
+            lobby,
+        }
+    );
+    Ok(())
+}

tests/test_examples.rs

@@ -0,0 +1,14 @@
+use std::process::{Command, Output};
+
+fn run_example(name: &str) {
+    let output: Output = Command::new("cargo")
+        .args(["run", "--example", name])
+        .output()
+        .expect("Failed to execute example");
+    assert!(output.status.success());
+}
+
+#[test]
+fn test_transcode() {
+    run_example("transcode");
+}