Tighten README: scannable structure for impatient readers #45

Merged

sessamekesh merged 1 commit from openhands/tighten-readme into main

2026-07-15 09:47:03 +00:00

igai-agent-bot commented

2026-07-14 22:22:32 +00:00

Member

Summary

Rewrites README.md to be significantly more concise and scannable — ~225 lines down from ~560+.

The old README was verbose and read like "AI-slop" with common LLM patterns (massive tables, exhaustive bundler matrix, repeated explanations). The information was good but buried. This rewrite structures it for an impatient reader who wants to quickly evaluate the package and then get to using it.

Structure

Short description (2 sentences) — what it is, with reference to indigocode.dev as the motivating consumer.
Installation — npm install + caveat about binary artifacts (.wasm + .igpack) with link to bundler config section.
Basic usage — <IgviewerProvider><TextureInspector /></IgviewerProvider> (plus <GeometryInspector> and bare <IgviewerCanvas> variants).
Modest customization — composing sub-components inside <TextureInspector> with a real example using TextureInspectorCanvas, TextureInspectorImageSelector, etc.
Advanced customization — using TextureInspectorProvider + useTextureInspector() hook to build fully custom UIs, plus useIgviewer(), useFilestoreState(), filter functions, file loading, provider props table, threading notes.
Building + running the demo locally — prerequisites, pnpm install / pnpm build:wasm / pnpm dev, dev:debug, CMake presets.
Bundler config & static assets — Vite config example with COOP/COEP headers, links for Webpack/RSPack/Turbopack, coi-serviceworker fallback, wasmUrl escape hatch.

Code examples

All inline code examples are built from the actual TypeScript source — component names, hook signatures, and context values match what's exported from packages/viewer-react/src/index.ts.

Notes

This PR was created by an AI agent (OpenHands) on behalf of the repository maintainer.
Package name updated to @indigocode/igasset-viewer-react (matching packages/viewer-react/package.json) — the old README used @indigocode-internal/igasset-viewer-react.

## Summary Rewrites `README.md` to be significantly more concise and scannable — ~225 lines down from ~560+. The old README was verbose and read like "AI-slop" with common LLM patterns (massive tables, exhaustive bundler matrix, repeated explanations). The information was good but buried. This rewrite structures it for an impatient reader who wants to quickly evaluate the package and then get to using it. ## Structure 1. **Short description** (2 sentences) — what it is, with reference to `indigocode.dev` as the motivating consumer. 2. **Installation** — npm install + caveat about binary artifacts (`.wasm` + `.igpack`) with link to bundler config section. 3. **Basic usage** — `<IgviewerProvider><TextureInspector /></IgviewerProvider>` (plus `<GeometryInspector>` and bare `<IgviewerCanvas>` variants). 4. **Modest customization** — composing sub-components inside `<TextureInspector>` with a real example using `TextureInspectorCanvas`, `TextureInspectorImageSelector`, etc. 5. **Advanced customization** — using `TextureInspectorProvider` + `useTextureInspector()` hook to build fully custom UIs, plus `useIgviewer()`, `useFilestoreState()`, filter functions, file loading, provider props table, threading notes. 6. **Building + running the demo locally** — prerequisites, `pnpm install` / `pnpm build:wasm` / `pnpm dev`, dev:debug, CMake presets. 7. **Bundler config & static assets** — Vite config example with COOP/COEP headers, links for Webpack/RSPack/Turbopack, coi-serviceworker fallback, `wasmUrl` escape hatch. ## Code examples All inline code examples are built from the actual TypeScript source — component names, hook signatures, and context values match what's exported from `packages/viewer-react/src/index.ts`. ## Notes - This PR was created by an AI agent (OpenHands) on behalf of the repository maintainer. - Package name updated to `@indigocode/igasset-viewer-react` (matching `packages/viewer-react/package.json`) — the old README used `@indigocode-internal/igasset-viewer-react`.

igai-agent-bot added 1 commit

2026-07-14 22:22:32 +00:00

Tighten README: scannable structure for impatient readers

Test / unit (pull_request_target) Successful in 19s

Details

Test / build-wasm (pull_request_target) Successful in 3m5s

Details

Test / browser (pull_request_target) Successful in 15s

Details

5628ddf6aa

Rewrite the README to be significantly more concise and scannable:
- Short description referencing indigocode.dev as motivating consumer
- Installation with binary artifact caveat
- Basic usage (Provider + Inspector)
- Modest customization (composing sub-components)
- Advanced customization (context hooks for custom UIs)
- Building + running the demo locally
- Bundler config (Vite, Webpack, RSPack) with static asset notes

Co-authored-by: openhands <openhands@all-hands.dev>