taigrr/bubbletea
1
0
Fork 0
mirror of https://github.com/taigrr/bubbletea.git synced 2026-04-02 02:59:09 -07:00
Code Issues Packages Projects Releases Wiki Activity

feat: add bubblezone to readme (closes #368) (#372)

Browse Source 
* feat: add bubblezone to readme (closes #368)

- also fixed a handful of grammar-related items in the readme.

Signed-off-by: Liam Stanley <me@liamstanley.io>

* chore: promote BubbleZone to main resource section

Co-authored-by: Christian Rocha <christian@rocha.is>
This commit is contained in:
Liam Stanley
2022-07-19 18:33:51 -04:00
committed by GitHub
parent 0a0182e55a
commit 6a88c0fc4e
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -50,7 +50,7 @@ This tutorial assumes you have a working knowledge of Go.
## Enough! Let's get to it.
For this tutorial we're making a shopping list.
For this tutorial, we're making a shopping list.
To start we'll define our package and import some libraries. Our only external
import will be the Bubble Tea library, which we'll call `tea` for short.
@@ -88,8 +88,8 @@ type model struct {
## Initialization
Next we’ll define our application’s initial state. In this case we’re defining
a function to return our initial model, however we could just as easily define
Next, we’ll define our application’s initial state. In this case, we’re defining
a function to return our initial model, however, we could just as easily define
the initial model as a variable elsewhere, too.
```go
@@ -106,8 +106,8 @@ func initialModel() model {
}
```
Next we define the `Init` method. `Init` can return a `Cmd` that could perform
some initial I/O. For now, we don't need to do any I/O, so for the command
Next, we define the `Init` method. `Init` can return a `Cmd` that could perform
some initial I/O. For now, we don't need to do any I/O, so for the command,
we'll just return `nil`, which translates to "no command."
```go
@@ -188,7 +188,7 @@ the Bubble Tea runtime to quit, exiting the program.
## The View Method
At last, it’s time to render our UI. Of all the methods, the view is the
simplest. We look at the model in it's current state and use it to return
simplest. We look at the model in its current state and use it to return
a `string`. That string is our UI!
Because the view describes the entire UI of your application, you don’t have to
@@ -277,15 +277,20 @@ actually watch out what address the first `dlv` run tells you to connect to.
* [Bubbles][bubbles]: Common Bubble Tea components such as text inputs, viewports, spinners and so on
* [Lip Gloss][lipgloss]: Style, format and layout tools for terminal applications
* [Harmonica][harmonica]: A spring animation library for smooth, natural motion
* [BubbleZone][bubblezone]: Easy mouse event tracking for Bubble Tea components
* [Termenv][termenv]: Advanced ANSI styling for terminal applications
* [Reflow][reflow]: Advanced ANSI-aware methods for working with text
[bubbles]: https://github.com/charmbracelet/bubbles
[lipgloss]: https://github.com/charmbracelet/lipgloss
[harmonica]: https://github.com/charmbracelet/harmonica
[bubblezone]: https://twitter.com/charmcli/status/1541772151660761088https://github.com/lrstanley/bubblezone
[termenv]: https://github.com/muesli/termenv
[reflow]: https://github.com/muesli/reflow
## Additional utility libraries to use with Bubble Tea
## Bubble Tea in the Wild
For some Bubble Tea programs in production, see: