Commit Graph

33 Commits

Author SHA1 Message Date
Leonid Satanovsky (home profile) 9667429be8 Correct stale C++ quickstart links in README (#4633)
# Description of Changes

Cpp-related tutorial stale links correction in Readme.

# API and ABI breaking changes

None

# Expected complexity level and risk

0

# Testing

N/A (?)

Signed-off-by: Leonid Satanovsky (home profile) <539045+leosat@users.noreply.github.com>
Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>
2026-03-18 14:05:15 -07:00
clockwork-labs-bot 36a948105e Overhaul README with up-to-date content (#4500)
The README was significantly out of date. This overhaul brings it in
line with the current docs and product state.

## What changed

**Content updates:**
- "What is SpacetimeDB" now mentions all 4 module languages (Rust, C#,
TypeScript, C++) instead of only Rust
- Removed the smart contracts comparison (outdated framing)
- Updated BitCraft description to match current docs wording
- Shortened the architecture description to be punchier

**New Quick Start section:**
- 5-step flow: install, login, init, dev, publish
- Introduces `spacetime dev` (the primary local development experience)
- Introduces `spacetime publish` to Maincloud
- Much more approachable than the old "Installation" wall of text

**New "How It Works" section:**
- Rust module code example showing tables and reducers
- TypeScript client code example showing `useTable` subscriptions
- Shows the core value prop in < 20 lines of code

**Language support:**
- Added TypeScript and C++ as server module languages
- Added Unreal Engine (C++) as a client SDK
- Listed all supported web frameworks (React, Next.js, Vue, Svelte,
Angular, Node.js, Bun, Deno)
- Fixed all doc links to current URL patterns (`/docs/quickstarts/...`)

**Build from source:**
- Collapsed into expandable `<details>` sections (macOS/Linux and
Windows)
- Removed duplicate Git for Windows instructions
- Still complete, just not the first thing you see

**Badges:**
- Added npm download count badge for the TypeScript SDK

**License:**
- Shortened to essentials with link to full license file

---------

Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
Co-authored-by: clockwork-labs-bot <clockwork-labs-bot@users.noreply.github.com>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2026-03-05 21:52:16 +00:00
Tyler Cloutier f13acc6102 Update README.md (#4119)
# Description of Changes

New tagline

Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>
2026-02-03 21:18:54 -05:00
Dejaime Antônio de Oliveira Neto 6be3037d09 Clarify Windows installation instructions in README (#3923)
# Description of Changes

This basically fixes a typo in the Read Me file.

# API and ABI breaking changes

No API or ABI changes.

# Expected complexity level and risk

Low risk

# Testing

No executable code changes

Signed-off-by: Dejaime Antônio de Oliveira Neto <contact@dejai.me>
2026-01-11 21:01:23 +00:00
Viktor Szépe f6da9e1f5f Fix typos (#2812)
Signed-off-by: Viktor Szépe <viktor@szepe.net>
2025-06-04 16:33:32 +00:00
John Detter 26c1387512 Add install from source instructions to README (#2443)
Co-authored-by: John Detter <no-reply@boppygames.gg>
2025-03-14 00:41:08 +00:00
joshua-spacetime be97181b72 update install instructions in readme (#2435) 2025-03-12 02:03:14 +00:00
Tyler Cloutier 7fb1f31d25 Update README.md (#2361)
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
Co-authored-by: John Detter <4099508+jdetter@users.noreply.github.com>
2025-03-07 17:11:43 +00:00
Tyler Cloutier a9cead86bd Update README.md with Rust crate and NuGet package stats
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2024-09-27 10:49:01 -04:00
Tyler Cloutier 84b29890a0 Typo
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2024-09-27 10:01:14 -04:00
Tyler Cloutier d6a215d0a6 Update README.md (#1575)
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2024-08-07 15:16:31 +00:00
John Detter cc733d92c4 Fix more broken links (#762)
Co-authored-by: John Detter <no-reply@boppygames.gg>
2024-01-26 09:29:42 -06:00
John Detter 1ba7eabfeb Fixed broken quickstart links in readme (#761)
Co-authored-by: John Detter <no-reply@boppygames.gg>
2024-01-26 09:10:12 -06:00
Ikko Eltociear Ashimine ba3e21dfc1 Fix typo in README.md (#193)
propogated -> propagated

refs https://github.com/clockworklabs/SpacetimeDB/pull/183

Signed-off-by: Ikko Eltociear Ashimine <eltociear@gmail.com>
2023-10-02 17:59:26 -07:00
John Detter 9ff8273f2d --locked is required now, otherwise our deps can break our build (#242)
Co-authored-by: Boppy <no-reply@boppygames.gg>
2023-08-25 18:28:47 +00:00
John Detter 22e1af8b26 Install from source instructions (#170)
* Install from source instructions

* Improved comment

---------

Co-authored-by: Boppy <no-reply@boppygames.gg>
2023-08-10 12:23:58 -05:00
Ingvar Stepanyan ba628075a6 Point C# to API reference for now (#164) 2023-08-09 14:00:43 +00:00
Tyler Cloutier a5f34a8a1a Added another link to the website
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-09 15:44:38 +02:00
Mario Montoya 45621c8909 Fix URL for the docker badge (#144) 2023-08-08 10:26:07 -05:00
Tyler Cloutier 90c9ab0017 Formatting for the README.md
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-03 22:43:14 +02:00
Tyler Cloutier 0f0dc955c9 Fix typo
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-03 14:30:52 +02:00
Phoebe Goldman 6fa2dc3b77 Fix a few typos in README, and reword a few sentences. (#127) 2023-08-02 15:41:45 +00:00
Tyler Cloutier 7998e0f4d0 Update README.md (#130)
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-02 17:18:11 +02:00
Tyler Cloutier f0b9c5cdc2 Update README.md
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-02 17:17:38 +02:00
Tyler Cloutier 99226dbd6a Update README.md
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-02 17:16:51 +02:00
Tyler Cloutier 00aa5dba5c Update README.md
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-02 17:09:58 +02:00
Tyler Cloutier b90220a549 Update README.md
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-02 17:06:50 +02:00
Tyler Cloutier 1058136cbd Updated README.md 2023-08-02 16:45:09 +02:00
Tyler Cloutier 5aa2cca33c Update README.md
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-02 16:34:14 +02:00
Tyler Cloutier f5708fc24c Update README.md
Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
2023-08-02 14:53:17 +02:00
Tyler Cloutier 0b039cf388 Fixed README.md formatting 2023-08-02 14:51:11 +02:00
Tyler Cloutier fc3b9efbbd Updated the README with content 2023-08-02 14:49:41 +02:00
Tyler Cloutier 1e29725584 Added README.md 2023-08-01 23:17:03 +02:00