Skip to content

Commit c6f56e5

Browse files
committed
Improve and update more docs
1 parent ede0c49 commit c6f56e5

File tree

1 file changed

+57
-6
lines changed

1 file changed

+57
-6
lines changed

docs/SHOWCASE.md

+57-6
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,25 @@ environment, you can opt for the **Docker method**. By using it, you can run Hom
2727
affecting your host system. This allows you to experiment and evaluate the installation before making any permanent
2828
changes. You can try HomeSetup on Docker, issuing one of the following commands:
2929

30+
#### amd64
31+
3032
```bash
31-
docker run --rm -it yorevs/hhs-centos
32-
docker run --rm -it yorevs/hhs-ubuntu
33-
docker run --rm -it yorevs/hhs-fedora
34-
docker run --rm -it yorevs/hhs-alpine
33+
docker run --rm -it yorevs/hhs-centos:amd64-latest
34+
docker run --rm -it yorevs/hhs-ubuntu:amd64-latest
35+
docker run --rm -it yorevs/hhs-fedora:amd64-latest
36+
docker run --rm -it yorevs/hhs-alpine:amd64-latest
3537
```
3638

39+
#### arm64
40+
41+
```bash
42+
docker run --rm -it yorevs/hhs-centos:arm64-latest
43+
docker run --rm -it yorevs/hhs-ubuntu:arm64-latest
44+
docker run --rm -it yorevs/hhs-fedora:arm64-latest
45+
```
46+
47+
> Alpine is not available for **arm64** architecture.
48+
3749
![HomeSetup Welcome](https://iili.io/H8ry3vI.png "Welcome to HomeSetup")
3850

3951
# HomeSetup's purpose
@@ -45,6 +57,8 @@ support for Bash (version 3.4+) on both _macOS_ and _Linux_ platforms. Moreover,
4557
support for [Zsh](https://www.zsh.org/) in the near future, catering to a wider range of users. If you're seeking a
4658
more powerful and efficient shell experience, HomeSetup is the perfect solution.
4759

60+
# Features
61+
4862
## Create your own syntax
4963

5064
HomeSetup is designed to prioritize a seamless user experience, making installation and usage easy for everyone.
@@ -65,10 +79,13 @@ functions, allowing for easy integration and customization.
6579

6680
Out-of-the-box, HomeSetup provides several plug-ins that extend its capabilities:
6781

68-
- **HSPM**: A tool for managing your development tools using installation and uninstallation recipes.
82+
- **ASK**: A tool to provide AI answers for your HomeSetup questions.
6983
- **FIREBASE**: A manager for integrating HomeSetup with Firebase.
84+
- **HSPM**: A tool for managing your development tools using installation and uninstallation recipes.
85+
- **SETTINGS**: A settings manager allowing you to easily changed/add/remove settings and converting them to .envrc or environment variables.
86+
- **SETUP**: HomeSetup initialization setup tool.
87+
- **STARSHIP**: The minimal, blazing-fast, and infinitely customizable prompt for any shell.
7088
- **UPDATER**: A HomeSetup update manager that keeps your installation up to date.
71-
- **SETMAN**: A settings manager allowing you to easily changed/add/remove settings and converting them to .envrc or environment variables.
7289

7390
When you initially run HomeSetup, you'll start with a clean slate without any customizations. However, as you use the
7491
tool, you'll have the opportunity to create your own dotfiles and make tweaks to tailor the experience to your liking.
@@ -116,6 +133,8 @@ HomeSetup offers seamless integration with [Firebase Realtime Database](https://
116133
securely save and load all of your dotfiles. This feature ensures that your setup is backed up using Google's powerful
117134
realtime database capabilities.
118135

136+
## Integrations
137+
119138
### Firebase
120139

121140
Please refer to the [Firebase Setup](FIREBASE_SETUP.md) document for detailed instructions on configuring your account.
@@ -144,6 +163,38 @@ If manual configuration feels too cumbersome, you can effortlessly explore one o
144163

145164
<img src="https://iili.io/JuzBxCN.png" />
146165

166+
### ColorLS
167+
168+
HomeSetup integrates with colorls, a Ruby gem that beautifies the terminal's ls command, with color and font-awesome icons. For more information, please access the [ColorLS project](https://github.com/athityakumar/colorls).
169+
170+
<img src="https://iili.io/dynBBSI.gif" />
171+
172+
### FZF
173+
174+
HomeSetup integrates with fzf, which is a general-purpose command-line fuzzy finder. For more information, please access the [FZF project](https://github.com/junegunn/fzf).
175+
176+
<img src="https://iili.io/dynqv6l.gif" />
177+
178+
### GTrash
179+
180+
HomeSetup integrates with GTrash, a featureful Trash CLI manager: alternative to rm and trash-cli. For more information, please access the [GTrash project](https://github.com/umlx5h/gtrash).
181+
182+
<img src="https://github.com/umlx5h/gtrash/raw/main/doc/image/demo.gif" />
183+
184+
### AskAI
185+
186+
HomeSetup has officially entered the AI landscape, introducing Taius, your dedicated AskAI assistant. Taius is here to provide accurate, on-demand answers to all your HomeSetup-related inquiries. Leveraging Retrieval-Augmented Generation (RAG) technology, Taius accesses and analyzes the full breadth of HomeSetup documentation, ensuring a seamless and enhanced user experience like never before.
187+
188+
<img src="https://iili.io/dy2Ga6u.gif">
189+
190+
> It's required that you own accounts on GoogleSearch API (for searching the web), DeepL (for translations), and OpenAI. For that is required that you provide the following Api Keys:
191+
192+
1. GOOGLE_API_KEY
193+
2. OPENAI_API_KEY
194+
3. DEEPL_API_KEY
195+
196+
For a detailed documentation about the AskAI, please access the [AskAI project](https://github.com/yorevs/askai).
197+
147198
# Shell is boring, I prefer a graphical interface
148199

149200
Indeed, graphical user interfaces (GUIs) can be helpful when getting started with a new application. However, they

0 commit comments

Comments
 (0)