From a486bd04ef7a47d8df50abdd100a3657515502ca Mon Sep 17 00:00:00 2001 From: G2 <72430668+G2-Games@users.noreply.github.com> Date: Sat, 3 Sep 2022 14:41:28 -0500 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5cc1e2c..d80c2a3 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,16 @@ This is a nice little script for your `.bashrc` that greets you on every launch, My goal with this script is to keep it simple, just a single line that gives useful information when you start the terminal. +#### Features: +- Relatively fast +- Works across many distros (update checking support) +- Clean and simple +- Written entirely in Bash +
+ ### Installing: #### Via Curl -Run `bash -c "$(curl -s https://raw.githubusercontent.com/G2-Games/welcome-sh/main/install.sh)"` to install it. +Run `bash -c "$(curl -s https://raw.githubusercontent.com/G2-Games/welcome-sh/main/install.sh)"` to install it. It installs to `~/.welcome/welcome.sh` Run it again to uninstall. @@ -18,8 +25,18 @@ To use it, download `welcome.sh` and place it in your home directory. Then add ` WIP Currently you can update by uninstalling and reinstalling, but this wipes all settings. I am working on making a better way to do this. +
+ +### Configs: +To configure settings, open `welcome.sh` in your text editor of choice and go to the bottom. There, you'll find a few settings: +![image](https://user-images.githubusercontent.com/72430668/188285444-96b98d3e-d69c-47a8-ae77-44c855c6e854.png) + +Here, you can re-arrange the modules, and turn off and on flatpak and recharge notifications. I recommend leaving flatpak off as it makes startup incredibly slow. + +I'm planning on making this config section a separate file later to make changing settings easier and updating easier. +
### TODO: - [x] Add easier way to install and update - [ ] Fix issues across other distros -- [ ] Add features? +- [ ] Add new features?