diff options
| author | Daniel Jankowski <daniel.jankowski@rub.de> | 2024-03-02 12:23:14 +0100 |
|---|---|---|
| committer | Daniel Jankowski <daniel.jankowski@rub.de> | 2024-03-02 12:23:14 +0100 |
| commit | a475861e992f5051bfa84dcded89b3201594cbd0 (patch) | |
| tree | 625361ee982d6053d64384fe5cea9cdb2a2e20cc | |
| parent | chore: add list of widget to README.md (diff) | |
| download | sl0pstatus-a475861e992f5051bfa84dcded89b3201594cbd0.tar.gz sl0pstatus-a475861e992f5051bfa84dcded89b3201594cbd0.tar.xz sl0pstatus-a475861e992f5051bfa84dcded89b3201594cbd0.zip | |
chore: use example config for quick start in README
| -rw-r--r-- | README.md | 29 |
1 files changed, 17 insertions, 12 deletions
@@ -96,20 +96,12 @@ config file, you can use `${pkgs.zjstatus}/bin/zjstatus.wasm` as the path. For configuring zjstatus, please follow the [documentation](https://github.com/dj95/zjstatus/wiki/2-%E2%80%90-Configuration). -## 🧱 Widgets - -The documentation for the widgets can be found in the [wiki](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets). +## 🏎️ Quick Start -The following widgets are available: - -- [command](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#command) -- [datetime](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#datetime) -- [mode](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#mode) -- [session](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#session) -- [swap layout](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#swap-layout) -- [tabs](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#tabs) +Place this configuration in your default layout file, e.g. `~/.config/zellij/layouts/default.kdl`: -## 🧪 Example configuration +> [!IMPORTANT] +> Using zjstatus involves creating new layouts and overriding the default one. This will lead to swap layouts not working, when they are not configured correctly. Please follow [this documentation](https://github.com/dj95/zjstatus/wiki/2-%E2%80%90-Configuration#swap-layouts) for getting swap layouts back to work, if you need them. ```javascript layout { @@ -149,6 +141,19 @@ layout { } ``` +## 🧱 Widgets + +The documentation for the widgets can be found in the [wiki](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets). + +The following widgets are available: + +- [command](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#command) +- [datetime](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#datetime) +- [mode](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#mode) +- [session](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#session) +- [swap layout](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#swap-layout) +- [tabs](https://github.com/dj95/zjstatus/wiki/3-%E2%80%90-Widgets#tabs) + ## 🚧 Development Make sure you have rust and the `wasm32-wasi` target installed. If using nix, you could utilize the nix-shell |