Skip to content

Commit

Permalink
Improved README and documentations - 3
Browse files Browse the repository at this point in the history
  • Loading branch information
Hugo Saporetti Junior committed Dec 13, 2023
1 parent 13f98b0 commit 21fad2d
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 21 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ integration with popular tools like Git, Gradle, Docker, and more.

> **THIS IT NOT JUST A DOTFILES FRAMEWORK**
- For the full documentation, access the [HomeSetup usage manual](docs/USAGE.md).
- See the [Showcase](docs/SHOWCASE.md) page to see some HomeSetup demos.
- For the full documentation, access the [HomeSetup usage manual](docs/USAGE.md).

## Key Features

- <img src="https://starship.rs/icon.png" width="14" height="14"/> [Starship](https://starship.rs/) prompt is here! HomeSetup now integrates with Starship.
- Automated setup for commonly used configurations, ensuring a hassle-free initial setup.
- A wide range of functions to simplify terminal configuration and streamline daily tasks.
- A visually appealing prompt with a monospaced font that supports [Font-Awesome](https://fontawesome.com/) icons (requires a [Nerd font](https://www.nerdfonts.com/).
- A visually appealing prompt with a monospaced font that supports [Font-Awesome](https://fontawesome.com/) icons (requires a [Nerd font](https://www.nerdfonts.com/)).
- Highly customizable **aliases**, **paths**, **environment variables** and more.
- A **universal package manager** helper that facilitates the installation of applications using recipes, catering to various package managers _beyond normal package managers_.
- Ability to upload custom dotfiles on [Firebase](https://firebase.google.com/) and easily download them across different environments.
Expand Down Expand Up @@ -213,7 +213,7 @@ any questions or encounter any issues during the update process, feel free to re

## Known Issues

- [In-Progress] We are aware that there is a problem with the cryptocode library when using python@3.12 and we are already working on a fix.
- [In-Progress] We are aware that there is a problems when using python@3.12 and we are already working on a fix.

## Contacts

Expand Down
24 changes: 24 additions & 0 deletions docs/FIREBASE_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,27 @@ You have now successfully configured Firebase for use with HomeSetup. To learn m
type in your shell:

`$ firebase help`

## HomeSetup integration

When you first access the firebase feature of HomeSetup, you will be prompted for some details:

[![FirebaseSetup](https://iili.io/H8ll1pa.png)](https://iili.io/H8ll1pa.png)

This information can be acquired at the firebase console:

![FirebaseSetup](https://iili.io/HUCM03x.png)

Once the Firebase integration is set up, you can start leveraging its benefits for storing your dotfiles. Enjoy the
convenience and peace of mind knowing that your configurations are stored securely in Firebase's Realtime Database.

To enhance security, it is recommended to generate a service token that allows HomeSetup to securely connect to your
Firebase account. You can find detailed instructions on how to generate your [Firebase private key here](https://github.com/yorevs/homesetup/blob/master/README.md#firebase-setup).

Once you have completed the configuration of your Firebase Realtime Database and generated the service token, you can
utilize it with HomeSetup to conveniently upload and download your dotfiles. This integration ensures that your
configurations are safely stored and easily accessible whenever needed. For further guidance and assistance with the
setup process, please refer to the provided documentation on the [User's Handbook](https://github.com/yorevs/homesetup/blob/master/docs/handbook/USER_HANDBOOK.md)
of HomeSetup.

[![FirebaseUsage](https://asciinema.org/a/585493.svg)](https://asciinema.org/a/585493)
51 changes: 33 additions & 18 deletions docs/SHOWCASE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# <img src="https://iili.io/HvtxC1S.png" width="34" height="34"> HomeSetup showcase
<img src="https://iili.io/HvtxC1S.png" width="64" height="64" align="right" />

# How can I try it ?
# HomeSetup Showcase
> The ultimate Terminal experience
## How can I try it ?

There are two ways of trying HomeSetup:

Expand All @@ -10,6 +13,12 @@ There are two ways of trying HomeSetup:
$ curl -o- https://raw.github.com/yorevs/homesetup/master/install.bash | bash
```

or

```bash
$ wget -qO- https://raw.github.com/yorevs/homesetup/master/install.bash | bash
```

### Run on Docker

If you're uncertain about the changes that the installation may bring or prefer to try it out in a controlled
Expand Down Expand Up @@ -58,6 +67,7 @@ Out-of-the-box, HomeSetup provides several plug-ins that extend its capabilities
- **HSPM**: A tool for managing your development tools using installation and uninstallation recipes.
- **FIREBASE**: A manager for integrating HomeSetup with Firebase.
- **UPDATER**: A HomeSetup update manager that keeps your installation up to date.
- **SETMAN**: A settings manager allowing you to easily changed/add/remove settings and converting them to .envrc or environment variables.

When you initially run HomeSetup, you'll start with a clean slate without any customizations. However, as you use the
tool, you'll have the opportunity to create your own dotfiles and make tweaks to tailor the experience to your liking.
Expand Down Expand Up @@ -90,7 +100,7 @@ To make your experience more convenient, it utilizes a set of aliases that provi
functions. These aliases are defined in the `.aliasdef` file located in the `$HHS_DIR` folder. While you have the
flexibility to manually edit this file, for the sake of this demonstration, the default definitions will be used.

You can watch a demonstration of HomeSetup's functionality in the asciicast provided below:
You can watch a demo of some of HomeSetup's features in the asciicast below:

[![HomeSetup-Aliases](https://asciinema.org/a/583777.svg)](https://asciinema.org/a/583777)

Expand All @@ -105,29 +115,34 @@ HomeSetup offers seamless integration with [Firebase Realtime Database](https://
securely save and load all of your dotfiles. This feature ensures that your setup is backed up using Google's powerful
realtime database capabilities.

### Firebase setup
### Firebase

Please check the [Firebase Setup](FIREBASE_SETUP.md) document for instructions on how to configure your account.

Once configured, you can use Firebase to upload/download your dotfiles to/from Firebase. This allows ou to have all of
your dotfiles everywhere.

<img src="https://iili.io/JuzoPwb.png" />

<img src="https://iili.io/JuzIzG4.png" />

### Starship

When you first access the firebase feature of HomeSetup, you will be prompted for some details:
HomeSetup provides an out-of-the-box starship.toml, but you can configure it the way you want byt typing:

[![FirebaseSetup](https://iili.io/H8ll1pa.png)](https://iili.io/H8ll1pa.png)
`$ hhs starship`

This information can be acquired at the firebase console:
or just

![FirebaseSetup](https://iili.io/HUCM03x.png)
`$ starship`

Once the Firebase integration is set up, you can start leveraging its benefits for storing your dotfiles. Enjoy the
convenience and peace of mind knowing that your configurations are stored securely in Firebase's Realtime Database.
If you are lazy to configure yourself, you can try on the the Starship presets:

To enhance security, it is recommended to generate a service token that allows HomeSetup to securely connect to your
Firebase account. You can find detailed instructions on how to generate your [Firebase private key here](https://github.com/yorevs/homesetup/blob/master/README.md#firebase-setup).
`$ starship preset`

Once you have completed the configuration of your Firebase Realtime Database and generated the service token, you can
utilize it with HomeSetup to conveniently upload and download your dotfiles. This integration ensures that your
configurations are safely stored and easily accessible whenever needed. For further guidance and assistance with the
setup process, please refer to the provided documentation on the [User's Handbook](https://github.com/yorevs/homesetup/blob/master/docs/handbook/USER_HANDBOOK.md)
of HomeSetup.
<img src="https://iili.io/JuzfXf9.png"/>

[![FirebaseUsage](https://asciinema.org/a/585493.svg)](https://asciinema.org/a/585493)
<img src="https://iili.io/JuzBxCN.png" />

# Shell is boring, I prefer a graphical interface

Expand Down

0 comments on commit 21fad2d

Please sign in to comment.