Documented V0.1 roadmap

Readme.md

@@ -1,19 +1,17 @@
 # Pingo - a simple ping visualizer written in go
 
-to run the project, simply `go run .`
+To run the project, simply `go run .`
 
-to install the project, simply `go install .`
+To install the project, simply `go install .`
 
-additionally, see `bin/` for additional pre-compiled binaries
+To compile the project, simply `go build cmd/pingo.go`
 
-## TODO:
+## Roadmap:
+> see ./issues for more. See also [issues-go][issues-go] for a browser TUI.
+ - [ ] "scroll peek" refinements
+ - [ ] documentation update
 
-- main.go:// TODO(main): determine chart heights dynamically by number of addresses
-- main.go:// TODO(performance): implement ping message channel buffering
-
-> NOTE: generate this list via `git grep '// TODO' -- ':(exclude)Readme.md'`
-
-# Core
+## Core
  - [x] Implements Bubbletea framework
  - [x] Implements lipgloss styling
  - [x] Implements viewport logic via bubbles
@@ -38,7 +36,7 @@ additionally, see `bin/` for additional pre-compiled binaries
 | [wish][wish]    | ssh tui client                     |
 |-----------------|------------------------------------|
 
-### color palette
+### proposed color palette
 
 | base      | lower     | middle    | secondary | primary   |
 |-----------|-----------|-----------|-----------|-----------|
@@ -49,5 +47,6 @@ additionally, see `bin/` for additional pre-compiled binaries
 [bbl]: charm.land/bubbles/v2
 [ntc]: https://github.com/NimbleMarkets/ntcharts
 [wish]: https://github.com/charmbracelet/wish
+[issues-go]: ssh://git/issues-go.git
 
 [](vim: nowrap)

issues/roadmap: set chart height peek via ratio/description

@@ -0,0 +1 @@
+Determine chart heights via ratio, ie. 19 line of 20 to show peek

issues/roadmap: set chart height peek via ratio/status

@@ -0,0 +1 @@
+open

issues/roadmap:-docs-update/description

@@ -0,0 +1,2 @@
+Provide a fully featured documentation overview in source
+

issues/roadmap:-docs-update/status

@@ -0,0 +1 @@
+open