Update README

Author: vadim-su

README.md

@@ -1,23 +1,35 @@
 # refluxer
 
-Rust API wrapper for [Fluxer](https://fluxer.app) — a free and open source instant messaging and VoIP platform.
+Rust API wrapper for [Fluxer](https://fluxer.app), a free and open source
+instant messaging and VoIP platform.
 
 ## Features
 
-- **HTTP REST API** — typed client for Fluxer's HTTP API with rate limiting
-- **WebSocket Gateway** — real-time event stream with auto-reconnect
-- **High-level Client** — event handler framework for building bots
-- **Feature flags** — include only what you need
+- Typed HTTP client for Fluxer's REST API
+- WebSocket gateway connection with heartbeat and reconnect support
+- High-level bot client with event handlers and a shared context
+- Strongly typed models, IDs, permissions, and snowflake support
+- Feature flags for keeping dependency sets small
 
-## Quick Start
+## Installation
 
 ```toml
 [dependencies]
-refluxer = { version = "0.1", features = ["client"] }
+refluxer = { version = "0.2", features = ["client"] }
 tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
 async-trait = "0.1"
 ```
 
+For HTTP-only usage, the default `http` feature is enough:
+
+```toml
+[dependencies]
+refluxer = "0.2"
+tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
+```
+
+## Quick Start
+
 ```rust
 use refluxer::model::message::Message;
 use refluxer::{Client, Context, EventHandler};
@@ -27,6 +39,10 @@ struct Handler;
 #[async_trait::async_trait]
 impl EventHandler for Handler {
     async fn message_create(&self, ctx: Context, msg: Message) {
+        if msg.author.bot.unwrap_or(false) {
+            return;
+        }
+
         if msg.content == "!ping" {
             ctx.send_message(msg.channel_id, "Pong!").await.ok();
         }
@@ -35,36 +51,35 @@ impl EventHandler for Handler {
 
 #[tokio::main]
 async fn main() -> Result<(), refluxer::Error> {
+    let token = std::env::var("FLUXER_TOKEN").expect("FLUXER_TOKEN env var required");
+
     let client = Client::builder()
-        .token("your_bot_token")
+        .token(&token)
         .event_handler(Handler)
         .build()?;
 
     client.start().await
 }
 ```
 
-## Feature Flags
+## HTTP Client
 
-| Feature   | Description                          | Default |
-|-----------|--------------------------------------|:-------:|
-| `http`    | REST client + models                 | yes     |
-| `gateway` | WebSocket Gateway (includes `http`)  | no      |
-| `client`  | High-level framework (includes `gateway`) | no  |
+```rust
+use refluxer::HttpClient;
 
-## HTTP-Only Usage
+#[tokio::main]
+async fn main() -> Result<(), refluxer::Error> {
+    let token = std::env::var("FLUXER_TOKEN").expect("FLUXER_TOKEN env var required");
+    let http = HttpClient::new(&token)?;
 
-```toml
-[dependencies]
-refluxer = "0.1"  # default features = ["http"]
-```
+    let me = http.get_current_user().await?;
+    println!("Logged in as {}#{}", me.username, me.discriminator);
 
-```rust
-let http = refluxer::HttpClient::new("your_token")?;
-let user = http.get_current_user().await?;
+    Ok(())
+}
 ```
 
-## Self-Hosted Instances
+Self-hosted Fluxer instances can be configured with the builder:
 
 ```rust
 let http = refluxer::HttpClient::builder()
@@ -73,39 +88,55 @@ let http = refluxer::HttpClient::builder()
     .build()?;
 ```
 
+## Feature Flags
+
+| Feature   | Description                                  | Default |
+|-----------|----------------------------------------------|:-------:|
+| `http`    | REST client and shared models                | yes     |
+| `gateway` | WebSocket gateway support, includes `http`   | no      |
+| `client`  | High-level bot framework, includes `gateway` | no      |
+
 ## Examples
 
 Lightweight examples live in `refluxer/examples`:
 
 ```sh
-FLUXER_TOKEN=your_token cargo run -p refluxer --example ping_bot --features client
 FLUXER_TOKEN=your_token cargo run -p refluxer --example http_only
+FLUXER_TOKEN=your_token cargo run -p refluxer --example ping_bot --features client
+FLUXER_TOKEN=your_token cargo run -p refluxer --example reminder_bot --features client
+FLUXER_TOKEN=your_token cargo run -p refluxer --example translator_bot --features client
 ```
 
-Dependency-heavy examples are standalone Cargo projects so they do not affect
-the main crate's dependency graph:
+Dependency-heavy examples are standalone Cargo projects:
 
 ```sh
 cargo run --manifest-path examples/gitbot/Cargo.toml
 cargo run --manifest-path examples/card_bot/Cargo.toml
 ```
 
-Bot examples require `FLUXER_TOKEN`. `card_bot` also requires `OPENAI_API_KEY`.
+Bot examples require `FLUXER_TOKEN`. `card_bot` also requires
+`OPENAI_API_KEY`.
 
-## Release Checks
+## Development
 
 ```sh
+cargo build --workspace
+cargo test --workspace
 cargo fmt --all --check
-cargo test --workspace --all-features --lib
-cargo clippy --workspace --all-targets --all-features -- -D warnings
-cargo test --manifest-path examples/gitbot/Cargo.toml
-cargo test --manifest-path examples/card_bot/Cargo.toml
+cargo clippy --workspace --all-targets --all-features
+```
+
+Fluxer-backed integration tests require `FLUXER_TOKEN` and `FLUXER_GUILD_ID`.
+Run them serially to avoid shared remote-state conflicts:
+
+```sh
+cargo test -p refluxer --features client -- --test-threads=1
 ```
 
 ## Publishing
 
 Publishing is automated by GitHub Actions when a `v*` tag is pushed. The tag
-version must match the crate version, for example `v0.2.0`.
+version must match `refluxer/Cargo.toml`, for example `v0.2.0`.
 
 The repository must have a `CARGO_REGISTRY_TOKEN` secret with permission to
 publish `refluxer`.