Preston_PLB
/
bubbletea
forked from Mirrors/bubbletea
1
0
Fork 0
Code Pull Requests Activity

Note about project being a pre-release

This commit is contained in:
Christian Rocha 2020-01-27 21:27:20 -05:00
parent 91271cacab
commit 4b4655b14a
No known key found for this signature in database
GPG Key ID: D6CC7A16E5878018
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,7 +1,9 @@
# Tea # Tea
茶! The fun, functional way to build terminal apps. A Go framework based on The fun, functional way to build terminal apps. A Go framework based on
[The Elm Architecture][elm]. [The Elm Architecture][elm]. 茶!
⚠️ This project is a pre-release! The API is subject to change a little.
## Simple example ## Simple example

3
tea.go
View File

@ -1,6 +1,7 @@
package tea package tea
import ( import (
"context"
"errors" "errors"
"io" "io"
"os" "os"
@ -18,7 +19,7 @@ type Cmd func(Model) Msg
// Sub is an event subscription. If it returns nil it's considered a no-op, // Sub is an event subscription. If it returns nil it's considered a no-op,
// but there's really no reason to have a nil subscription. // but there's really no reason to have a nil subscription.
type Sub func(Model) Msg type Sub func(context.Context, Model) Msg
// Subs is a keyed set of subscriptions. The key should be a unique // Subs is a keyed set of subscriptions. The key should be a unique
// identifier; two different subscriptions should not have the same key // identifier; two different subscriptions should not have the same key