maddie/ShellMommy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme fixes

Browse Source
This commit is contained in:
Maddie 2023-02-28 21:49:27 +00:00 committed by Madeleine
parent 96376acb62
commit 86f215b257
No known key found for this signature in database
GPG Key ID: 64FAA9959751687D
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,25 +1,26 @@
# a-better-shell-mommy # ❤️ a-better-shell-mommy
Simple shell-mommy script that works on zsh as well as bash. Simple [shell-mommy](https://github.com/sudofox/shell-mommy) script that works on zsh as well as bash.<br>
## Usage ## Usage
Instead of running `mommy command`, this script just generates responses.
- Positive responses: `./shell-mommy.sh -p` - Positive responses: `./shell-mommy.sh -p`
- Negative responses: `./shell-mommy.sh -n` - Negative responses: `./shell-mommy.sh -n`
## Env vars ## Env vars
- `$MOMMYS_LITTLE` - what *you* will be called [default: "girl"] - `$MOMMYS_LITTLE` - what *you* will be called [default: `"girl"`]
- `$MOMMYS_ROLE` - what the *mommy* will be called [default: "mommy"] - `$MOMMYS_ROLE` - what the *mommy* will be called [default: `"mommy"`]
- `$MOMMYS_PRONOUN` - what pronouns the *mommy* will use for itself [default: "her"] - `$MOMMYS_PRONOUN` - what pronouns the *mommy* will use for itself [default: `"her"`]
- `$MOMMY_COLOR` - ansi escape code used at the start of the response for color [default: '\e[38;5;217m'] - `$MOMMY_COLOR` - ansi escape code used at the start of the response for color [default: `'\e[38;5;217m'`]
## Example ## Example
**With env vars:** **With env vars:**
```sh ```sh
$MOMMYS_ROLE knows $MOMMYS_PRONOUN little $MOMMYS_LITTLE can do better~ ❤️" "$MOMMYS_ROLE knows $MOMMYS_PRONOUN little $MOMMYS_LITTLE can do better~ ❤️"
``` ```
**Defaults to:** **Defaults to:**
``` ```sh
mommy knows her little girl can do better~ ❤️ "mommy knows her little girl can do better~ ❤️"
``` ```
## Add to .zshrc ## Add to .zshrc
@ -30,5 +31,5 @@ precmd() { [ $? -ne 1 ] && /path/to/shell-mommy -p }
**On failed commands:** **On failed commands:**
```sh ```sh
precmd() { [ $? -ne 0 ] && /path/to/shell-mommy -n } precmd() { [ $? -eq 0 ] && /path/to/shell-mommy -n }
``` ```