Skip to content

Commit f1d6c7b

Browse files
committed
docs: fix up the readme
1 parent fe8da62 commit f1d6c7b

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,22 @@ This package automatically downloads and publishes the latest `libsql-server` re
77
## Installation
88

99
```bash
10+
# Locally install in a project
1011
vlt install sqld
1112
```
1213

14+
## Usage
15+
16+
```bash
17+
# Start sqld server
18+
vlx sqld --help
19+
20+
# Example: Start with a database file
21+
vlx sqld --db-path ./my-database.db
22+
```
23+
24+
### Binaries
25+
1326
The appropriate platform-specific binary will be automatically installed based on your system:
1427

1528
- `@sqld/darwin-arm64` - macOS ARM64 (Apple Silicon)
@@ -28,20 +41,6 @@ Windows is not directly supported as `libsql-server` does not provide native Win
2841

2942
The Linux ARM64 or x64 binary (depending on your system architecture) will be used within the WSL environment.
3043

31-
## Usage
32-
33-
### Command Line
34-
35-
After installation, you can use `sqld` directly from the command line:
36-
37-
```bash
38-
# Start sqld server
39-
vlx sqld --help
40-
41-
# Example: Start with a database file
42-
vlx sqld --db-path ./my-database.db
43-
```
44-
4544
## License
4645

4746
MIT

0 commit comments

Comments
 (0)