diff --git a/profile/README.md b/profile/README.md index e69de29..f5667e9 100644 --- a/profile/README.md +++ b/profile/README.md @@ -0,0 +1,131 @@ +

+The Charm logo +

+
+speed dial charm +
+ +# Why hello there, welcome to **Charm** + +Charm started as a group of friends exchanging .vimrc tips and building open +source libraries. It's grown into a team of developers working to glamourize the +command line. + +## Apps + +### Markdown Reader + +[Glow][glow] is a terminal based markdown reader designed from the ground up to bring +out the beauty—and power—of the CLI. + +

+ Glow UI Demo +

+ +### Skate +### Pop +### Mods +### Freeze +### VHS +### Gum +### Wishlist +### Soft Serve + +## Libraries (Gophers only!) + +Our first two projects were [Glow][glow] and [Glamour][glamour]. When we thought about modern +product development one thing we felt was lacking when building command line +apps was the separation of concerns between structure and style. Here's what +we've built in chronological order. + +### Markdown rendering + +[Glamour][glamour] gives you stylesheet-based markdown rendering for your CLI apps. + +

+ Glamour Example +

+ + +### Textual User Interfaces + +[Bubble Tea][bubbletea] is a TUI framework for Go based on the Elm +architecture. + +

+ Bubble Tea Example +

+ +[Bubbles][bubbles] are reusable UI components for Bubble Tea. This includes +spinners, lists, tables, file pickers, paginators, progress bars, and more. + +### Styling the command line + +[Lip Gloss][lipgloss] is the layout engine for not only nearly every Bubble Tea +TUI, but also many general purpose CLI-based tools. Over 4,800 open source tools +use Lip Gloss. + +

+ Lip Gloss Example +

+ +### Serving over SSH + +[Wish][wish] is an SSH server with sensible defaults and a collection of +middlewares that makes building SSH apps really easy. You can serve TUIs and/or +CLIs over SSH. No HTTPS certificates required. Authentication with SSH keys +included. + +Try it yourself by running either of these commands from your terminal: + +```bash +# connect to our git server +ssh git.charm.sh + +# connect to an online coffee shop (not affiliated, we're just big fans) +ssh terminal.shop +``` + +

+ Wish Example +

+ +### Quick forms in the terminal + +[Huh][huh] is a simple yet powerful library for building interactive forms and prompts in the terminal. + +

+ Huh Example +

+ +### Stylized logging + +[Log][log] is a minimal and colorful Go logging library. 🪵 + +

+ Log Example +

+ +## Why the command line? Why now? + +The command line has been a ubiquitous platform for computing for the past 30+ +years thanks, in part, to its focus on simple tools that do one thing well, the +ability to easily compose those tools into unique solutions, and a massive +library of existing command line programs from which to draw from. Many of these +attributes stand in stark contrast to the web and its siloed data, lack of +composability and large, opaque solutions that often include a healthy dose of +tracking, ads and other dark patterns. + +The command line seems to us like a healthy alternative to the web and closed +mobile platforms. It's also ripe for an update with a focus on user-centric +design and encrypted, self-hostable networked services. Let's build the +command line platform for the next 30+ years. + +[glamour]: https://github.com/charmbracelet/glamour +[glow]: https://github.com/charmbracelet/glow +[bubbletea]: https://github.com/charmbracelet/bubbletea +[bubbles]: https://github.com/charmbracelet/bubbles +[lipgloss]: https://github.com/charmbracelet/lipgloss +[huh]: https://github.com/charmbracelet/huh +[wish]: https://github.com/charmbracelet/wish +[log]: https://github.com/charmbracelet/log