From 7e30940f79ba67819ed0d19c82e3c15f430e7261 Mon Sep 17 00:00:00 2001 From: Sebastian Jeltsch Date: Mon, 13 Jan 2025 22:17:42 +0100 Subject: [PATCH] Minor documentation updates. --- README.md | 2 +- docs/src/content/docs/comparison/pocketbase.mdx | 5 +---- docs/src/content/docs/index.mdx | 4 ++-- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9fced445..4c909fb7 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ To get a full list of commands, simply run `trail --help` . ## Building -If you have all the necessary dependencies (Rust, node.js, pnpm, ...) +If you have all the necessary dependencies (Rust, protobuf, node.js, pnpm) installed, you can build TrailBase by running: ```bash diff --git a/docs/src/content/docs/comparison/pocketbase.mdx b/docs/src/content/docs/comparison/pocketbase.mdx index a37426cd..795f32ad 100644 --- a/docs/src/content/docs/comparison/pocketbase.mdx +++ b/docs/src/content/docs/comparison/pocketbase.mdx @@ -39,12 +39,9 @@ authentication and file storage on top of SQLite. That said and for the sake of this article, let's look at some of the differences and extra features that PocketBase provides: -- TrailBase does not yet provide realtime APIs allowing clients to subscribe to - data changes. - PocketBase can also be used as a Go framework, i.e. instead of using the binary release one can build a custom binary with custom endpoints. - Similarly you can use Rust to do the same with TrailBase, however the APIs - aren't stable yet. + Similarly you can use Rust to do the same with TrailBase. Likewise, TrailBase has a few nifty tricks up its sleeve: diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx index d2b25a0b..69e75aca 100644 --- a/docs/src/content/docs/index.mdx +++ b/docs/src/content/docs/index.mdx @@ -1,11 +1,11 @@ --- title: Welcome to TrailBase -description: A blazingly fast, single-file, open-source application server with type-safe APIs, built-in JS/ES6/TS Runtime, Auth, and Admin UI built on Rust, SQLite & V8 +description: A blazingly fast, single-file, open-source application server with type-safe APIs, built-in JS/ES6/TS Runtime, Realtime, Auth, and Admin UI built on Rust, SQLite & V8 template: splash hero: tagline: A blazingly fast, open-source application server with type-safe APIs, - built-in JS/ES6/TS Runtime, Auth, and Admin UI built on Rust, SQLite & V8. + built-in JS/ES6/TS Runtime, Realtime, Auth, and Admin UI built on Rust, SQLite & V8.

Simplify with fewer moving parts: an easy to self-host, single-file,