Suggestions

Author: erikdubbelboer

README.md

@@ -1,11 +1,12 @@
 # The Poki Networking Library &nbsp;&nbsp;[<img src="https://img.shields.io/npm/v/@poki/netlib?color=lightgray">](https://www.npmjs.com/package/@poki/netlib)
 
 <img align="right" src="https://raw.githubusercontent.com/poki/netlib/main/.github/logo.png" width=140>
-The Poki Networking Library is a powerful peer-to-peer networking solution for web games, leveraging WebRTC datachannels to enable direct UDP connections between players. Think of it as the Steam Networking Library for the web, designed to make WebRTC as simple to use as WebSockets for game development.
+The Poki Networking Library is a peer-to-peer networking library for web games, leveraging WebRTC datachannels to enable direct UDP connections between players. Think of it as the Steam Networking Library for the web, designed to make WebRTC as simple to use as WebSockets for game development.
 
 <p></p>
 
-> ⚠️ **Warning**: This library is still under development and considered a beta. The library API can change. Make sure to get in touch if you want to go live with this so we can keep you up-to-date about changes.
+> [!WARNING]
+> This library is still under development and considered a beta. While it's being actively used in production by some games, the API can change. Make sure to get in touch if you want to go live with this so we can keep you up-to-date about changes.
 
 ## Features
 
@@ -24,7 +25,6 @@ The Poki Networking Library is a powerful peer-to-peer networking solution for w
   - Optimized for real-time gaming with minimal latency
   - Perfect for fast-paced multiplayer games
   - Unlike WebSockets or HTTP (which use TCP), UDP doesn't pause new packets when one packet is slow or dropped
-  - This is ideal for real-time updates like position data
   - Includes reliable data channels for critical events like chat messages or NPC spawns
 
 - **Easy to Use**
@@ -63,7 +63,7 @@ network.on('ready', () => {
 
 // Or join an existing one
 network.on('ready', () => {
-  network.join('LOBBY-CODE')
+  network.join('ed84')
 })
 ```
 
@@ -80,13 +80,10 @@ network.on('message', (peer, channel, data) => {
 
 For more detailed examples and API documentation:
 - [Basic Usage Guide](./docs/basic-usage.md)
-- [Example Implementation](./example/)
+- [Example Usage](./example/)
 
-## Project Status
+## Roadmap
 
-This library is currently in alpha stage. While it's being actively used in production by some games, the API may change without warning and without bumping the major version. Please contact us if you're planning to use this library in production.
-
-### Roadmap
 - [x] Basic P2P connectivity
 - [x] Lobby system
 - [x] Lobby discovery and filtering
@@ -118,9 +115,8 @@ UDP Transport
 - Facilitates WebRTC connection establishment
 
 #### 2. STUN/TURN Servers
-- STUN: Helps peers discover their public IP
-- TURN: Provides fallback relay when direct P2P fails
-- Hosted by Poki (or self-hostable)
+- STUN: Helps peers discover their public IP (by default Google STUN servers)
+- TURN: Provides fallback relay when direct P2P fails (when using the Poki hosted version, Cloudflare TURN servers are used)
 
 ## Self-Hosting
 

docs/basic-usage.md

@@ -2,7 +2,7 @@
 
 ## Getting Started
 
-#### 1. Installation
+#### 1. Add dependency
 First add [@poki/netlib](https://www.npmjs.com/package/@poki/netlib) as a dependency to your project:
 ```sh
 yarn add @poki/netlib
@@ -36,13 +36,8 @@ network.on('lobby', code => {
 // Wait for network to be ready before creating
 network.on('ready', () => {
   network.create({
-    public: true,          // Make lobby visible in listings
-    maxPlayers: 4,         // Optional: limit number of players
-    password: 'secret',    // Optional: add password protection
-    customData: {          // Optional: add custom lobby data
-      map: 'aztec',
-      gameMode: 'deathmatch'
-    }
+    public: true,   // Make lobby visible in listings
+    maxPlayers: 4,  // Optional: limit number of players
   })
 })
 ```
@@ -51,7 +46,7 @@ network.on('ready', () => {
 When a player wants to join an existing game:
 ```js
 network.on('ready', () => {
-  network.join(lobbyCode, 'secret') // Second parameter is optional password
+  network.join(lobbyCode)
 })
 ```
 
@@ -105,15 +100,6 @@ network.on('disconnected', peer => {
 })
 ```
 
-##### Monitoring Connection Quality
-```js
-// Check for errors
-network.on('error', error => {
-  console.error('Network error:', error)
-  // Handle or display error to user
-})
-```
-
 #### 6. Listing Lobbies
 You can list available lobbies using the `list` function. This function supports filtering using MongoDB-style filters: