Overhaul README with up-to-date content#4500
Open
clockwork-labs-bot wants to merge 1 commit intomasterfrom
Open
Overhaul README with up-to-date content#4500clockwork-labs-bot wants to merge 1 commit intomasterfrom
clockwork-labs-bot wants to merge 1 commit intomasterfrom
Conversation
Major changes: - Update 'What is SpacetimeDB' to mention all 4 module languages (Rust, C#, TypeScript, C++) instead of only Rust - Replace verbose installation section with concise quick start flow: install, login, init, dev, publish - Add spacetime dev workflow (the primary local dev experience) - Add Maincloud deployment step - Add 'How It Works' section with Rust module + TypeScript client code examples showing tables, reducers, and subscriptions - Update language support tables to include TypeScript modules, C++ modules, and Unreal Engine SDK - List all supported client frameworks (React, Next.js, Vue, Svelte, Angular, Node.js, Bun, Deno) - Fix doc links to current URL patterns (/docs/quickstarts/...) - Collapse build-from-source instructions into expandable details sections (macOS/Linux and Windows) to reduce visual clutter - Remove stale smart contracts comparison - Remove duplicate Git for Windows instructions - Add npm download badge - Shorten license section (link to FAQ for details)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README was significantly out of date. This overhaul brings it in line with the current docs and product state.
What changed
Content updates:
New Quick Start section:
spacetime dev(the primary local development experience)spacetime publishto MaincloudNew "How It Works" section:
useTablesubscriptionsLanguage support:
/docs/quickstarts/...)Build from source:
<details>sections (macOS/Linux and Windows)Badges:
License: