Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
honhimW committed Dec 17, 2024
1 parent 271d01d commit 86d5a75
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,17 @@ cargo run
## Data storage
User's data will be stored in `~/.config/ratisui/`:

### Application Configuration
```ron
// ~/.config/ratisui/config.ron
(
fps: 45, // tui render fps limitation
scan_size: 500, // redis key scan size,
try_format: false, // fotmat raw data
theme: Some("my-dark") // ~/.config/ratisui/theme/my-dark.ron
scan_size: 500, // redis key scan size,
try_format: false, // fotmat raw data
theme: Some("your-theme") // ~/.config/ratisui/theme/your-theme.ron
)
```

### Databases Configuration
```ron
// ~/.config/ratisui/databases.ron
(
Expand All @@ -64,7 +65,7 @@ User's data will be stored in `~/.config/ratisui/`:
db: 0,
protocol: RESP3,
),
"remote cluster": (
"remote cluster": ( // Cluster mode automatically detected
host: "cluster.host",
port: 6000,
username: None,
Expand All @@ -77,6 +78,21 @@ User's data will be stored in `~/.config/ratisui/`:
},
)
```
### Themes Configuration

> [!NOTE]
>
> See [Theme template](./assets/theme-template.ron) for more details.
```ron
// ~/.config/ratisui/theme/your-theme.ron
(
toast: (
info: Tailwind(GREEN, C700),
warn: Yellow,
error: Rgb(255, 0, 0),
),
)
```

## Features

Expand Down

0 comments on commit 86d5a75

Please sign in to comment.