Skip to content

Commit f5390f2

Browse files
committed
fix: update description
1 parent bcad149 commit f5390f2

2 files changed

Lines changed: 29 additions & 29 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = "gus"
33
version = "1.0.0"
44
edition = "2024"
5-
description = "🐻 Git user switcher for quickly switching between local git users"
5+
description = "Git User Switcher - Simple command line utility for quickly/easily switching between local git users"
66
authors = ["Jamie Weavis"]
77
repository = "https://github.com/jamieweavis/gus"
88

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# gus
22

3-
> 🐻 Git user switcher for quickly switching between local git users
3+
Git User Switcher - Simple command line utility for quickly/easily switching between local git users
44

55
[![ci](https://github.com/jamieweavis/gus/actions/workflows/ci.yml/badge.svg)](https://github.com/jamieweavis/gus/actions)
66
[![downloads](https://img.shields.io/github/downloads/jamieweavis/gus/total)](https://github.com/jamieweavis/gus/releases)
@@ -9,7 +9,7 @@
99

1010
## Installation
1111

12-
Install via [Homebrew](https://brew.sh):
12+
Install via [Homebrew](https://brew.sh) (currently macOS only):
1313

1414
```sh
1515
brew tap jamieweavis/gus
@@ -18,26 +18,6 @@ brew install gus
1818

1919
## Usage
2020

21-
### Help
22-
23-
Print usage and package information:
24-
25-
```sh
26-
$ gus
27-
28-
gus 1.0.0 (https://github.com/jamieweavis/gus)
29-
30-
🐻 Git user switcher for quickly switching between local git users
31-
32-
Usage: gus <command>
33-
34-
COMMANDS
35-
<id> Switch to user with the provided ID
36-
- Switch to the previous user
37-
list, ls List users and their IDs
38-
config Open `~/.config/gus.toml` in your $EDITOR
39-
```
40-
4121
### Switch
4222

4323
Switch to a user by their ID:
@@ -66,12 +46,32 @@ $ gus ls
6646

6747
### Edit
6848

69-
Edit your gus config file in your configured shell `$EDITOR` (alternatively you can manually edit the file at `~/.config/gus.toml`, see the [configuration](#configuration) section for more details):
49+
Edit your gus config file in your configured shell `$EDITOR` (alternatively you can manually edit the file at `~/.config/gus.toml`, see the [Configuration](#configuration) section for more details):
7050

7151
```sh
7252
$ gus edit
7353
```
7454

55+
### Help
56+
57+
Print usage and package information:
58+
59+
```sh
60+
$ gus
61+
62+
gus 1.0.0 (https://github.com/jamieweavis/gus)
63+
64+
Git User Switcher - Simple command line utility for quickly/easily switching between local git users
65+
66+
Usage: gus <command>
67+
68+
COMMANDS
69+
<id> Switch to user with the provided ID
70+
- Switch to the previous user
71+
list, ls List users and their IDs
72+
config Open `~/.config/gus.toml` in your $EDITOR
73+
```
74+
7575
## Configuration
7676

7777
When you run `gus` for the first time a `~/.config/gus.toml` file is created. This file is used by gus to store your git users and is prepopulated with a your current git user.
@@ -146,17 +146,17 @@ Uninstall the binary from your local crates:
146146
cargo uninstall gus
147147
```
148148

149-
## Built With
150-
151-
- [Rust](https://github.com/rust-lang/rust)
152-
153149
## Disclaimer
154150

155151
I'm not a Rust engineer, this is just for fun!
156152

153+
## Built With
154+
155+
- [Rust](https://github.com/rust-lang/rust)
156+
157157
## Related
158158

159-
- [homebrew-gus](https://github.com/jamieweavis/homebrew-gus) - 🍺 Brew tap & formula for gus
159+
- [homebrew-gus](https://github.com/jamieweavis/homebrew-gus) - Brew tap & formula for gus - Git User Switcher
160160

161161
## License
162162

0 commit comments

Comments
 (0)