Skip to content

Commit 7aa39eb

Browse files
committed
docs: update README with logos, remove outdated binary size, add contribution notice
- Add LocalGPT logo to main title and Gen section headers - Remove outdated ~27MB binary size reference from README and architecture docs - Rename "Signed Security Policy" to "Signed Custom Rules" for clarity - Add crates.io installation option for Gen mode - Add Apache-2.0 contribution licensing notice - Update blog link wording from "full story" to "initial story"
1 parent c9d6d31 commit 7aa39eb

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
# LocalGPT
2+
# <img src="https://localgpt.app/logo/localgpt-icon-app.png" width="50" height="50" alt="LocalGPT" /> LocalGPT
33

4-
A local device focused AI assistant built in Rust — persistent memory, autonomous tasks, ~27MB binary. Inspired by and compatible with OpenClaw.
4+
A local device focused AI assistant built in Rust — persistent memory, autonomous tasks. Inspired by and compatible with OpenClaw.
55

66
`cargo install localgpt`
77

@@ -169,7 +169,7 @@ localgpt sandbox status # Show sandbox capabilities
169169
localgpt sandbox test # Run smoke tests
170170
```
171171

172-
### Signed Security Policy (LocalGPT.md)
172+
### Signed Custom Rules (LocalGPT.md)
173173

174174
Place a `LocalGPT.md` in your workspace to add custom rules (e.g. "never execute `rm -rf`"). The file is HMAC-SHA256 signed with a device-local key so tampering will be detected:
175175

@@ -286,11 +286,14 @@ LocalGPT includes a Proof of Concept for running the desktop Egui UI in the brow
286286

287287
See [`docs/egui-web-poc.md`](docs/egui-web-poc.md) for details on architecture, benefits, tradeoffs, and implementation.
288288

289-
## Gen Mode (World Generation)
289+
## <img src="https://localgpt.app/logo/localgpt-icon.png" width="100" height="100" alt="LocalGPT" /> Gen Mode (World Generation)
290290

291291
`Gen` is a separate binary (`localgpt-gen`) in the workspace — not a `localgpt gen` subcommand.
292292

293293
```bash
294+
# Install from crates.io
295+
cargo install localgpt-gen
296+
294297
# Install from this repo
295298
cargo install --path crates/gen
296299

@@ -320,7 +323,7 @@ localgpt-gen --agent my-gen-agent
320323

321324
## Blog
322325

323-
[Why I Built LocalGPT in 4 Nights](https://localgpt.app/blog/why-i-built-localgpt-in-4-nights) — the full story with commit-by-commit breakdown.
326+
[Why I Built LocalGPT in 4 Nights](https://localgpt.app/blog/why-i-built-localgpt-in-4-nights) — the initial story with commit-by-commit breakdown.
324327

325328
## Built With
326329

@@ -339,3 +342,7 @@ Rust, Tokio, Axum, SQLite (FTS5 + sqlite-vec), fastembed, eframe
339342
## License
340343

341344
[Apache-2.0](LICENSE)
345+
346+
### Your contributions
347+
348+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed under the Apache-2.0 license, without any additional terms or conditions.

docs/architecture.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ LocalGPT is a **fresh Rust implementation** inspired by OpenClaw's architecture,
1515
| Memory system | Markdown + SQLite | Same approach |
1616
| Heartbeat | HEARTBEAT.md driven | Same approach |
1717
| Startup time | ~2-3s | <100ms |
18-
| Binary size | ~100MB (node) | ~27MB |
1918

2019
### Borrowed Concepts
2120

0 commit comments

Comments
 (0)