Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 4 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<img src="public/logo.jpg" width="256" height="256">

# Lattice

A modular terminal dashboard built with [Bubble Tea](https://github.com/charmbracelet/bubbletea). Lattice ships with a set of built-in modules and supports external plugins written in any language.
Expand All @@ -15,8 +17,8 @@ A modular terminal dashboard built with [Bubble Tea](https://github.com/charmbra
╰──────────────────────╯╰──────────────────────╯
╭──────────────────────╮╭──────────────────────╮
│ WEATHER ││ UPTIME │
│ ☀ Clear ││ 3d 7h 22m │
🌡 +18°C (feels +16) ││ since Mar 13, 08:14 │
│ ☀ Clear ││ 3d 7h 22m │
│ +18°C (feels +16) ││ since Mar 13, 08:14 │
╰──────────────────────╯╰──────────────────────╯
```

Expand Down Expand Up @@ -191,26 +193,6 @@ while IFS= read -r line; do
done
```

## Project structure

```
lattice/
main.go Entry point, CLI, app model
internal/
layout/layout.go Grid layout engine
modules/ Built-in module implementations
clock.go, system.go, github.go,
weather.go, uptime.go, greeting.go
plugin/runner.go External plugin process manager
pkg/ Public API (importable by plugins)
module/module.go Module interface
config/config.go Config types + loader
registry/registry.go Module registry (Register/Get/List)
styles/styles.go Shared colors + helpers
plugin/sdk.go Plugin SDK (types + Run helper)
config.example.yaml Example configuration
```

## License

The software is protected by the MIT License. See [LICENSE](LICENSE) for details.
Binary file added public/logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.