Renamed Catnip to Catnap

README.md

@@ -1,5 +1,5 @@
-# 🌿 Catnip Documentation
-View the site [here](https://iinsertNameHere.github.io/catnip-docs)
+# 🌿 Catnap Documentation
+View the site [here](https://iinsertNameHere.github.io/catnap-docs)
 
 ## ✏️ Editing the site
 The source files for the site are in docs/src/

docs/book.toml

@@ -3,4 +3,4 @@ authors = ["iinsertNameHere"]
 language = "en"
 multilingual = false
 src = "src"
-title = "Catnip Systemfetch"
+title = "Catnap Systemfetch"

docs/src/Configuration/Colors.md

@@ -1,5 +1,5 @@
 # 🎨 Colors
-Catnip's color system uses a ColorId, which is made up of the colors first and last letter, enclosed in characters that indicate the type of color.
+Catnap's color system uses a ColorId, which is made up of the colors first and last letter, enclosed in characters that indicate the type of color.
 
 **Color Types:**
 - Foreground Normal  -> `(#)`

docs/src/Configuration/Distros.md

@@ -7,7 +7,7 @@ To create a new DistroArt object, add a new section to the file (replace `distro
 [distroname]
 ```
 
-Catnip's DistroArt objects have three possible keys.
+Catnap's DistroArt objects have three possible keys.
 1. `margin`
 2. `art`
 3. `alias`

docs/src/Configuration/Files.md

@@ -1,9 +1,9 @@
 # 🗒️ Config Files 
 
 # Default config files
-The two main config files are located at `$XDG_CONFIG_HOME` or `~/.config/catnip/` if `$XDG_CONFIG_HOME` is not set.
+The two main config files are located at `$XDG_CONFIG_HOME` or `~/.config/catnap/` if `$XDG_CONFIG_HOME` is not set.
 
-The first file, called `config.toml`, is the file in which you configure the looks of catnip and in the second file, called `distros.toml`, you can find the definitions of all the distro logos used by catnip.
+The first file, called `config.toml`, is the file in which you configure the looks of catnap and in the second file, called `distros.toml`, you can find the definitions of all the distro logos used by catnap.
 
 > **NOTE:** The config files are written in the [TOML](https://toml.io) configuration file format.
 
@@ -12,5 +12,5 @@ Using the `-c` and `-a` arguments, you can define custom locations for these two
 
 *For example:*
 ```shell
-$ catnip -c /path/to/config.toml -a /path/to/distros.toml
+$ catnap -c /path/to/config.toml -a /path/to/distros.toml
 ```

docs/src/Configuration/Misc/FigletLogos.md

@@ -5,7 +5,7 @@
 The `[misc.figletLogos]` sections contains variables to configure *Figlet generated text logos*.
 
 > **NOTE:** For this to work, the optional dependency `figlet` has to be installed.
-> You will also need a figlet font file. You can get them at <http://www.figlet.org/fontdb.cgi> or the `basic.flf` font file from the `scripts/` folder in the Catnip repo.
+> You will also need a figlet font file. You can get them at <http://www.figlet.org/fontdb.cgi> or the `basic.flf` font file from the `scripts/` folder in the Catnap repo.
 
 ## Enable/Disable
 To enable or disable `figletLogos`, just set the `enable` variable to `true`/`false`.

docs/src/Configuration/Misc/Main.md

@@ -19,7 +19,7 @@ The `stats_margin_top` dictates how many lines the `StatsBlock` will be placed d
 
 *`stats_margin_top` is set to `3`:*
 ```
-$ catnip
+$ catnap
     :
     : 3x
     :
@@ -36,7 +36,7 @@ $ catnip
 
 *`stats_margin_top` is set to `1`:*
 ```
-$ catnip
+$ catnap
     : 1x
 ╭────────────╮
 │ > user     │

docs/src/Configuration/Stats.md

@@ -2,7 +2,7 @@
 
 **File:** `config.toml`
 
-> **NOTE:** The execution time of Catnip will increase when enabling the package manager, weather and GPU stats. Catnip **cannot** in any way decrease the time for the weather and package manager stats. This is due to the fact that the package manager stat is dependent on the speed of your distro's package manager, and the weather stat is dependent on your internet speed as well as the response time of the weather info website, [wttr.in](https://github.com/chubin/wttr.in).
+> **NOTE:** The execution time of Catnap will increase when enabling the package manager, weather and GPU stats. Catnap **cannot** in any way decrease the time for the weather and package manager stats. This is due to the fact that the package manager stat is dependent on the speed of your distro's package manager, and the weather stat is dependent on your internet speed as well as the response time of the weather info website, [wttr.in](https://github.com/chubin/wttr.in).
 
 ## Icons
 You can change the icon of any `stat` inside of the `[stats]` section.
@@ -77,7 +77,7 @@ You can use `separators` to add a horizontal line across the `StatsBlock`.
 ╰────────────╯
 ```
 
-You define a new `separator` using the prefix `sep_` and a unique name. The value of the `separator` can be anything as it's not used by catnip.
+You define a new `separator` using the prefix `sep_` and a unique name. The value of the `separator` can be anything as it's not used by catnap.
 
 ```toml
 sep_[name] = "My very cool separator!!!"
@@ -96,5 +96,5 @@ The disk with index `0` is always the system drive.
 
 You can get all available *disk* `stats` using:
 ```shell
-$ catnip -g disks
+$ catnap -g disks
 ```

docs/src/Setup/Installation.md

@@ -1,10 +1,4 @@
-# 🪡 Installing Catnip
-
-## Arch
-If you are using any Arch-based distro with access to the [AUR](https://aur.archlinux.org/), you can install the [catnip-git](https://aur.archlinux.org/packages/catnip-git) package using your preferred AUR helper.
-```sh
-$ yay -S catnip-git
-```
+# 🪡 Installing Catnap
 
 ## Build from source
 
@@ -19,21 +13,21 @@ $ yay -S catnip-git
     - `curl`: For weather stat.
     - `pciutils`: For GPU stat.
 
-**2.** Clone the official catnip repository:
+**2.** Clone the official catnap repository:
 ```shell
-git clone https://github.com/iinsertNameHere/catnip.git
+git clone https://github.com/iinsertNameHere/catnap.git
 ```
 
 **3.** Change dir into repository:
 ```shell
-cd ./catnip
+cd ./catnap
 ```
 
 **4.** Run install using **nim**:
 ```shell
 nim install
 ```
-This will automatically build catnip and install it inside of your `/usr/local/bin` folder.
+This will automatically build catnap and install it inside of your `/usr/local/bin` folder.
 
 > **IMPORTANT**:
 > For the default icons to work, make sure you set a [NerdFont](https://www.nerdfonts.com/) as you terminal font. In addition, for the weather module to work, you will need a font that supports emojis.

docs/src/Setup/Usage.md

@@ -1,58 +1,58 @@
 # 💻 Usage
 
 
-## Run catnip in you terminal:
+## Run catnap in you terminal:
 ```bash
-$ catnip
+$ catnap
 ```
 This will use the default config files
 
 ## Change the distro icon:
 ```bash
-$ catnip -d <distro>
+$ catnap -d <distro>
 ```
 This will use the specified distro logo as long as it is in the distros.toml file.
 
 ## Check the current version:
 ```bash
-$ catnip -v
+$ catnap -v
 ```
-This will show the commit hash your version of catnip is built on.
+This will show the commit hash your version of catnap is built on.
 
 ## Get a list of arguments:
 ```bash
-$ catnip --help
+$ catnap --help
 ```
 
 ## Get the stats value:
 ```bash
-$ catnip -g <stat>
+$ catnap -g <stat>
 ```
 This will output the value of the stat to standard output.
 
 ## Change the location of the config.toml file
 ```bash
-$ catnip -c <path>
+$ catnap -c <path>
 ```
 >**Tip:**
->By default, Catnip will use the `$XDG_CONFIG_HOME/catnip/config.toml` or `~/.config/catnip/config.toml` if the `$XDG_CONFIG_HOME` environment variable is not set.
+>By default, Catnap will use the `$XDG_CONFIG_HOME/catnap/config.toml` or `~/.config/catnap/config.toml` if the `$XDG_CONFIG_HOME` environment variable is not set.
 
 ## Change the location of the distros.toml file
 ```bash
-$ catnip -a <path>
+$ catnap -a <path>
 ```
 >**Tip:**
->By default, Catnip will use the `$XDG_CONFIG_HOME/catnip/distros.toml` or `~/.config/catnip/distros.toml` if the `$XDG_CONFIG_HOME` environment variable is not set.
+>By default, Catnap will use the `$XDG_CONFIG_HOME/catnap/distros.toml` or `~/.config/catnap/distros.toml` if the `$XDG_CONFIG_HOME` environment variable is not set.
 
 ## Change the margin (whitespace) for the logo
 ```bash
-$ catnip -m <margin>
+$ catnap -m <margin>
 ```
 The format for the margin is: x,x,x (where x is a number)
 
 ## Change the layout
 ```bash
-$ catnip -l <layout>
+$ catnap -l <layout>
 ```
 This changes the layout of the logo or stats
 
@@ -63,18 +63,18 @@ Available layouts:
 
 ## Enable or disable Figlet logos
 ```bash
-$ catnip -fe <on/off>
+$ catnap -fe <on/off>
 ```
 
 ## Changes the margin (whitespace) of the Figlet logo
 ```bash
-$ catnip -fm <matgin>
+$ catnap -fm <matgin>
 ```
 The format for the margin is: x,x,x (where x is a number)
 
 ## Changes the font used for Figlet
 ```bash
-$ catnip -ff <font file>
+$ catnap -ff <font file>
 ```
 >**Tip:**
 >You will need a Figlet font file for this option, otherwise it will error out. You can get font files at <http://www.figlet.org/fontdb.cgi>