Merge pull request #90 from rubiin/patch-1

doc: Update README.md to include site

Author: kRHYME7

Configs/keybinds_hint.sh

@@ -39,7 +39,7 @@ Example:
 Users can also add a global overrides inside ${hydeConfDir}/hyde.conf
   Available overrides:
 
-    kb_hint_delim=">"                         ﯦ add a custom custom delimeter
+    kb_hint_delim=">"                         ﯦ add a custom custom delimiter
     kb_hint_conf=("file1.conf" "file2.conf")  ﯦ add a custom keybinds.conf path (add it like an array)
     kb_hint_width="30em"                      ﯦ custom width supports [ 'em' '%' 'px' ] 
     kb_hint_height="35em"                     ﯦ custom height supports [ 'em' '%' 'px' ]
@@ -260,7 +260,7 @@ jsonData="$(
   hyprctl binds -j | jq -L "$tmpMapDir" -c '
 include "hyde-keybinds";
 
-  #? Funtions to Convert modmask into Keys, There should be a beter math for this but Im lazy
+  #? Functions to Convert modmask into Keys, There should be a better math for this but Im lazy
   #? Also we can just map it manually too
   def get_keys:
     if . == 0 then
@@ -299,7 +299,7 @@ def get_keycode:
 #!if .modmask and .modmask != " " and .modmask != "" then .modmask |= (split(" ") | map(select(length > 0)) | if length > 1 then join("  + ") else .[0] end) else .modmask = "" end |
 if .keybind and .keybind != " " and .keybind != "" then .keybind |= (split(" ") | map(select(length > 0)) | if length > 1 then join("  + ") else .[0] end) else .keybind = "" end |  #? Clean up
   .arg |= (arg_mapping[.] // .) | #? See above for how arg is converted
- #!    .desc_executable |= gsub(".sh"; "") | #? Maybe Usefull soon removes ".sh" to file  
+ #!    .desc_executable |= gsub(".sh"; "") | #? Maybe Useful soon removes ".sh" to file  
   #? Creates a key desc... for fallback if  "has description" is false
   .desc_executable |= (executables_mapping[.] // .) | #? exclusive for "exec" dispatchers 
   .desc_dispatcher |= (description_mapping[.] // .)  |  #? for all other dispatchers

Hyde

@@ -861,7 +861,7 @@ USAGE
 	screencap) #? Use rofi to select screenshot options \n !!  kills another rofi session
 		Launch-Screencap
 		;;
-	search) #? [*] Web Search\nﯦ supports shorthand e.g 'g: some thing' (this uses google.com to search for 'some thing')\nﯦ ':' is use as delimter\nﯦ Custom search-engines should be in 'search.lst' and be declared inside ./hyde.conf ( e.g search_file="$HOME/.config/hyde/search.lst" ) 
+	search) #? [*] Web Search\nﯦ supports shorthand e.g 'g: some thing' (this uses google.com to search for 'some thing')\nﯦ ':' is use as delimiter\nﯦ Custom search-engines should be in 'search.lst' and be declared inside ./hyde.conf ( e.g search_file="$HOME/.config/hyde/search.lst" ) 
 
 	shift
 		Launch-Search "${@}"
@@ -884,7 +884,7 @@ USAGE
 run() { #? Executable utilities
 	case $1 in
 
-	airplane_mode) #? Toogle airplane mode\n\tﯦ Toogles wifi 
+	airplane_mode) #? Toggle airplane mode\n\tﯦ Toogles wifi 
 	airplane-mode
 	;;
 	audio_idle) #? Inhibits idle when player status: 'Playing
@@ -909,7 +909,7 @@ run() { #? Executable utilities
     --scan          ?  Use 'tesseract' to scan image then add to clipboard
     --stop          ?  Stop every instance of Screencap
     --reset         ?  Reinitialize 
-    --deps          ?  Chek and resolve dependencies
+    --deps          ?  Check and resolve dependencies
 [END]
 USAGE
 		;;

README.md

@@ -4,11 +4,11 @@
 ![hyde_cli_banner](https://raw.githubusercontent.com/krhyme7/hyde-cli/master/Assets/hyde_cli_banner.png)
 
   <br>
-  <a href="#installation"><kbd> <br> Installation <br> </kbd></a>&ensp;&ensp;
+  <a href="https://hydeproject.pages.dev/guides/installation/"><kbd> <br> Installation <br> </kbd></a>&ensp;&ensp;
   <a href="https://raw.githubusercontent.com/HyDE-Project/Hyde-cli/master/USAGE.md"><kbd> <br> Usage <br> </kbd></a>&ensp;&ensp;
-  <a href="#faq"><kbd> <br> FAQ <br> </kbd></a>&ensp;&ensp;
+  <a href="https://hydeproject.pages.dev/reference/faqs/"><kbd> <br> FAQ <br> </kbd></a>&ensp;&ensp;
   <a href="#support"><kbd> <br> Support <br> </kbd></a>&ensp;&ensp;
-  <a href="#roadmap"><kbd> <br> Roadmap <br> </kbd></a>&ensp;&ensp;
+  <a href="https://hydeproject.pages.dev/reference/roadmap/"><kbd> <br> Roadmap <br> </kbd></a>&ensp;&ensp;
   <a href="https://github.com/HyDE-Project/Hyde-cli/wiki"><kbd> <br> Wiki <br> </kbd></a>&ensp;&ensp;
   <a href="https://discord.gg/qWehcFJxPa"><kbd> <br> HyDE Discord <br> </kbd></a>
   <br><br><br>
@@ -23,165 +23,6 @@ For example, we have a functional TUI restore tool that follows `restore_cfg.lst
 > While Hyde-cli is stable, it is important to note that these scripts do alter and *could* potentially mess up your system configuration.
 > We ask that you use this tool carefully and report any bugs you find.
 
-## Installation
-
-To install, execute the following command:
-
-```
-curl -sL https://raw.githubusercontent.com/HyDE-Project/Hyde-cli/master/install.sh | bash
-```
-
-> [!Note]
-> For User who do not have root access:
-> ` export HYDE_LOCAL=1 ` to install this package locally
-
-For other working install solutions, see the following below.
-
-### Arch Linux
-
-Use your preferred AUR helper `paru` or `yay`:
-
-```
-paru -Sy hyde-cli-git
-```
-
-```
-yay -Sy hyde-cli-git
-```
-
-Use makepkg:
-
-```
-git clone https://aur.archlinux.org/hyde-cli-git.git
-cd ./hyde-cli
-makepkg -si
-```
-
-### Make
-
-Install required dependencies: `git make fzf tree ttf-jetbrains-mono-nerd`.
-
-Clone:
-
-```
-git clone https://github.com/HyDE-Project/Hyde-cli
-cd ./Hyde-cli
-```
-
-To install:
-
-```
-make
-```
-
-To uninstall:
-
-```
-make uninstall
-```
-
-To update:
-
-```
-make update clean install
-```
-
-> [!Note]
-> User who do not have root access should provide this flag for ` make `; ` make LOCAL=1 `
-
-## Usage
-
-Run: `Hyde man` if Hyde-cli is installed.
-<br>
-View [USAGE](https://raw.githubusercontent.com/HyDE-Project/Hyde-cli/master/USAGE.md)
-
----
-
-#### Installation Instructions for HyDE with Hyde-install
-
-> [!Note]
-> To achieve the best experience, it is encouraged you perform a fresh install of HyDE.
-
-1) **Basic Installation**
-
-- To install HyDE with the defaults, simply run the following command:
-
-    ```
-    Hyde-install
-    ```
-
-> [!Important]
-> *Already  have HyDE before you discover this CLI?*
-> Simply run this command
-> ` Hyde-install --link --dir ~/HyDE `
-> Note that the ` ~/HydE ` is the path to the clone directory.
-> See **Advanced Installation** below for more info.
-
-2) **Advanced Installation**
-
-- For more control over the installation process, you can use the following options:
-
-  - **Specify Local Directory**: To clone HyDE into a specific local directory and run the installation, use the `-d` or `--dir` flag followed by the path of the directory.
-
-      ```
-      Hyde-install --dir /path/to/directory
-      ```
-
-  - **Specify Remote Git Repository**: To clone HyDE from a specific remote git repository, use the `-g` or `--git` flag followed by the URL of the repository.
-
-      ```
-      Hyde-install --git https://host/owner/repository
-      ```
-
-  - **Link Local Git Repository**: To link a local git repository, use the `-l` or `--link` flag.
-
-      ```
-      Hyde-install --link
-      ```
-3) **Sync changes**
-  - If you want to get the latest changes from the `hyprdots/HyDE` repo and apply to your local install
-    ```
-    Hyde update
-    Hyde restore Config
-    ```
-
-> [!Important]
-> If you have previously installed HyDE without using the CLI, you can still use the CLI to manage your installation.
-> To do this, combine the --dir and --link flags where the local cloned repository is located.
->
-> For example:
->
-> ```
-> Hyde-install --dir /path/to/cloned/hyde --link
-> ```
-
-## FAQ
-
-#### Activate Shell-completions
-
-If shell completions are not working, you can manually source them from the terminal. You can also persist the changes by adding the snippet at the end of your `.zshrc`, `.bashrc`.
-
-<details>
-<summary>Zsh</summary>
-
-```sh
-source Hyde.zsh
-```
-
-</details>
-
-<details>
-<summary>Bash</summary>
-
-```sh
-source Hyde.bash
-```
-</details>
-
-#### Images are not being shown in the terminal
-  Make sure your terminal supports images. If you are using a terminal emulator that does not support images, you can use a terminal emulator that does, such as `kitty`.
-  
-</details>
 
 ## Support
 
@@ -192,14 +33,3 @@ If you would like to support this project, but don't know how, here are some way
 - I don't really know what the use of the stars is, but feel free to leave one!
 
   [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A3TECUZ) 
-## Roadmap
-
-This is the current unfinished and completed plans of the project:
-
-- [ ] Add interactive installation using fzf
-- [x] Interactive restore config following `restore_cfg.lst`
-- [x] Interactive package installation following `custom_apps.lst`
-- [x] Interactive theme selection
-- [x] Shell swap selection
-- [ ] Separate TUI from CLI
-- [ ] More to come...

USAGE.md

@@ -248,7 +248,7 @@ Usage: Hyde [Function] [options]
 
 			 [search]  ↪️  [*] Web Search
   			                 💡supports shorthand e.g 'g: some thing' (this uses google.com to search for 'some thing')
-  			                 💡':' is use as delimter
+  			                 💡':' is use as delimiter
   			                 💡Custom search-engines should be in 'search.lst' and be declared inside ./hyde.conf ( e.g search_file="$HOME/.config/hyde/search.lst" )
 
 						[--reset] ↪️ 	Reset cache
@@ -258,8 +258,8 @@ Usage: Hyde [Function] [options]
  
 [run]                       ↪️ Executable utilities
 
-			 [airplane_mode]  ↪️  Toogle airplane mode
-  			                 	💡Toogles wifi
+			 [airplane_mode]  ↪️  Toggle airplane mode
+  			                 	💡Toggles wifi
 
 			 [audio_idle]  ↪️  Inhibits idle when player status: 'Playing