Skip to content

Commit f7e3066

Browse files
authored
update docs (#6)
* update ui to latest * 🚚 smaller Signed-off-by: peter szemraj <[email protected]> * 📝 validate/update to current Signed-off-by: peter szemraj <[email protected]> * 🎨 Signed-off-by: peter szemraj <[email protected]> * Make GUI the primary quick-start path in docs Highlight cargo run with gui features; add --release optimization note. Update README and dev guide to establish as recommended entry point. Signed-off-by: peter szemraj <[email protected]> --------- Signed-off-by: peter szemraj <[email protected]>
1 parent d1a31f3 commit f7e3066

File tree

5 files changed

+21
-17
lines changed

5 files changed

+21
-17
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,35 @@
44

55
A fast, localhost-only pastebin with a modern editor, built in Rust.
66

7-
![LocalPaste Screenshot](assets/ui.png)
7+
![LocalPaste Screenshot](assets/ui.jpg)
88

99
---
1010

1111
## Features
1212

13-
- **Native Desktop App** egui-based editor with palette-matched theming
14-
- **Automatic Language Detection** cached detection + offline syntax highlighting
15-
- **Auto-Save** debounce to disk; manual export for sharing
16-
- **Semantic Naming** auto-generates memorable names (e.g., mythic-ruby)
17-
- **Folder Organization** nested folders with drag & drop
18-
- **Keyboard Shortcuts** Ctrl+N (new), Ctrl+K (search), Ctrl+D (delete)
19-
- **Zero Runtime Dependencies** single binary, embedded Sled database
13+
- **Native Desktop App** - egui-based editor with palette-matched theming
14+
- **Automatic Language Detection** - cached detection + offline syntax highlighting
15+
- **Auto-Save** - debounce to disk; manual export for sharing
16+
- **Semantic Naming** - auto-generates memorable names (e.g., "mythic-ruby")
17+
- **Folder Organization** - nested folders with drag & drop and cycle-safe parenting
18+
- **Keyboard Shortcuts** - Ctrl+N (new), Ctrl+K (search), Ctrl+D (delete)
19+
- **Zero Runtime Dependencies** - single binary, embedded Sled database
2020

2121
## Quick Start
2222

2323
LocalPaste.rs provides multiple ways to interact with your pastes:
2424

25-
- `localpaste-gui` Native egui desktop application (primary experience)
26-
- `localpaste` Axum HTTP API + legacy browser UI
27-
- `lpaste` Command-line interface for terminal usage
25+
- `localpaste-gui` - Native egui desktop application (primary experience)
26+
- `localpaste` - Axum HTTP API + legacy browser UI
27+
- `lpaste` - Command-line interface for terminal usage
2828

2929
### Run the Desktop App
3030

3131
```bash
32-
cargo run --bin localpaste-gui --features gui --release
32+
cargo run --bin localpaste-gui --features="gui"
3333
```
3434

35-
The compiled binary `target/release/localpaste-gui` can be launched directly.
35+
Add `--release` once you’re ready to ship or benchmark; during development the command above starts the latest GUI build immediately.
3636

3737
### Run the Web Server / API
3838

assets/ui.jpg

477 KB
Loading

assets/ui.png

-230 KB
Binary file not shown.

docs/dev.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Project Structure
44

5-
`
5+
```text
66
localpaste.rs/
77
├── Cargo.toml
88
├── src/
@@ -19,7 +19,7 @@ localpaste.rs/
1919
├── docs/ # Project documentation
2020
├── assets/ # Screenshots / design references
2121
└── target/ # Build artifacts (git-ignored)
22-
`
22+
```
2323

2424
## Key Design Decisions
2525

@@ -54,8 +54,11 @@ RESTful endpoints:
5454
- `GET /api/search?q=` - Search pastes
5555
- `POST /api/folder` - Create folder
5656
- `GET /api/folders` - List folders
57+
- `PUT /api/folder/:id` - Update folder (rename or re-parent; rejects cycles)
5758
- `DELETE /api/folder/:id` - Delete folder
5859

60+
Folder operations enforce tree integrity: the API returns `400 Bad Request` if a move would introduce a cycle in the hierarchy.
61+
5962
## Development Workflow
6063

6164
### Building the Project
@@ -80,7 +83,8 @@ cargo build --release --bin lpaste
8083

8184
```bash
8285
# Run the desktop app
83-
cargo run --bin localpaste-gui --features gui --release
86+
cargo run --bin localpaste-gui --features="gui"
87+
# (append --release when you need an optimized build)
8488

8589
# Run the server/API (legacy web UI)
8690
cargo run --bin localpaste --release

docs/ui-palette.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ These canonical values are applied inside `src/gui/mod.rs` and should be reused
1616
| `COLOR_DANGER` | `#F85149` | Destructive actions |
1717
| `COLOR_BORDER` | `#30363D` | Divider strokes |
1818

19-
The screenshot at `assets/ui.png` shows the original layout these colors came from.
19+
The screenshot at `assets/ui.jpg` shows the original layout these colors came from.

0 commit comments

Comments
 (0)