From 0cc5e71a6328beaa4336b3fdce87caa49828a076 Mon Sep 17 00:00:00 2001 From: Christian Rocha Date: Wed, 29 Jul 2020 16:34:01 -0400 Subject: [PATCH] Flesh out README and add Charm badge --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 43 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 62ab6f6..2a53681 100644 --- a/README.md +++ b/README.md @@ -7,28 +7,63 @@ Some components for [Bubble Tea](https://github.com/charmbraclet/bubbletea): * Paginator * Viewport +[glow]: https://github.com/charmbraclet/glow +[charm]: https://github.com/charmbraclet/charm + +These components are used in production in [Glow][glow] and [Charm][charm]. + + ## Spinner -A spinner, useful for indicating that some kind of invisible operation is -happening. There are a couple default ones, but you can also pass your own -”frames.” +A spinner, useful for indicating that some kind an operation is happening. +There are a couple default ones, but you can also pass your own ”frames.” + +* [Example](https://github.com/charmbracelet/tea/tree/master/examples/spinner) + ## Text Input -A text input field, akin to an `` in HTML. +A text input field, akin to an `` in HTML. Supports unicode, +pasting, in-place scrolling when the value exceeds the width of the element and +the common, and many customization options. + +An example of the text field + +* [Example, one field](https://github.com/charmbracelet/tea/tree/master/examples/textinput) +* [Example, many fields](https://github.com/charmbracelet/tea/tree/master/examples/textinput) + ## Paginator A component for handling pagination logic and optionally drawing pagination UI. +This component is used in [Glow][glow] to browse documents and [Charm][charm] to +browse SSH keys. + + ## Viewport -A viewport for vertically scrolling content which optionally includes standard +A viewport for vertically scrolling content. Optionally includes standard pager keybindings and mouse wheel support. A high performance mode is available -for applications which make use of the alterate screen buffer. This is -generally only necessary when dealing with content with a very large amount of -ANSI escape sequences. +for applications which make use of the alterate screen buffer. + +* [Example](https://github.com/charmbracelet/tea/tree/master/examples/pager) + +This compoent is well complimented with [Reflow][reflow] for ANSI-aware +indenting and text wrapping. + +[reflow]: https://github.com/muesli/reflow + ## License [MIT](https://github.com/charmbracelet/teaparty/raw/master/LICENSE) + + +*** + +A [Charm](https://charm.sh) project. + +the Charm logo + +Charm热爱开源!