Skip to content

Commit 2bf28d5

Browse files
committed
add aciicast
1 parent 7fc7887 commit 2bf28d5

File tree

2 files changed

+33
-16
lines changed

2 files changed

+33
-16
lines changed

README.md

+22-15
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,48 @@
1-
Sunbeam is a framework for writing keyboard-driven TUIs, by composing list, form and detail views. It's designed to be easy to use, and easy to extend.
1+
Sunbeam is a TUI framework for creating keyboard-driven applications from simple scripts.
22

3-
### Sunbeam runs on all platforms
3+
You can think of it as a mix between an application launcher like [raycast](https://raycast.com) and a fuzzy-finder like [fzf](https://github.com/junegunn/fzf).
44

5-
Sunbeam is distributed as a single binary, so you can run it on any platform. The sunbeam extension system is also designed to be cross-platform.
5+
[![asciicast](https://asciinema.org/a/614506.svg)](https://asciinema.org/a/614506)
6+
7+
## Features
8+
9+
## Runs on all platforms
10+
11+
Sunbeam is distributed as a single binary, available for all major platforms. Sunbeam also comes with a lot of utilities to make it easy to create cross-platform scripts.
612

713
![sunbeam running in alacritty](./static/alacritty.png)
814

9-
### Sunbeam is language agnostic
15+
## Supports any language
1016

1117
Sunbeam provides multiple helpers for writing scripts in POSIX shell, but you can also use any other language.
1218

1319
The only requirement is that your language of choice can read and write JSON.
1420

1521
Example Extensions:
1622

17-
- [VS Code](https://github.com/pomdtr/sunbeam-vscode)
18-
- [File Browser](https://github.com/pomdtr/sunbeam-files)
19-
- [Bitwarden](https://github.com/pomdtr/sunbeam-bitwarden)
20-
- [Github](https://github.com/pomdtr/sunbeam-github)
21-
- [TLDR Pages](https://github.com/pomdtr/sunbeam-tldr)
22-
- [Devdocs](https://github.com/pomdtr/sunbeam-devdocs)
23+
- [VS Code (typescript)](https://github.com/pomdtr/sunbeam-vscode)
24+
- [File Browser (python)](https://github.com/pomdtr/sunbeam-files)
25+
- [Bitwarden (sh)](https://github.com/pomdtr/sunbeam-bitwarden)
26+
- [Github (sh)](https://github.com/pomdtr/sunbeam-github)
27+
- [TLDR Pages (sh)](https://github.com/pomdtr/sunbeam-tldr)
28+
- [Devdocs (sh)](https://github.com/pomdtr/sunbeam-devdocs)
2329

24-
### Sunbeam is easy to extend
30+
### Easy to extend
2531

2632
Instead of reiventing the wheel, sunbeam relies on your familiarity with git and github to make it easy to create, update, publish and install extensions.
2733

28-
Creating a new extension is as easy as writing a script. Sunbeam supports installing extension from any github repository, and can also interact with REST APIs.
34+
Creating a new extension is as easy as writing a script.\
35+
Sharing an extension is as easy as pushing it to github.
2936

30-
Since sunbeam uses `git` under the hood, allowing you to create private extensions by using private git repositories.
37+
If you prefer, you can also distribute your extensions as http endpoints, and use sunbeam as a client.
3138

3239
![sunbeam running in vscode](./static/vscode.png)
3340

34-
### Sunbeam supports custom clients
41+
### Bring your own UI
3542

3643
Sunbeam comes with a built-in TUI to interact with your scripts, but you can also use any other client.
3744

38-
Currently the only alternative client is [sunbeam-raycast](https://github.com/pomdtr/sunbeam-raycast).
45+
See the client section for more details.
3946

4047
![raycast integration](./static/raycast.png)
4148

oranda.json

+11-1
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,20 @@
2020
"theme": "axodark"
2121
},
2222
"components": {
23-
"changelog": false,
23+
"artifacts": {
24+
"package_managers": {
25+
"preferred": {
26+
"brew": "brew install pomdtr/tap/sunbeam",
27+
"go": "go install github.com/pomdtr/sunbeam@latest"
28+
}
29+
}
30+
},
2431
"mdbook": {
2532
"path": "./",
2633
"theme": true
34+
},
35+
"changelog": {
36+
"read_changelog_file": true
2737
}
2838
}
2939
}

0 commit comments

Comments
 (0)