Skip to content

Commit 488f471

Browse files
committed
Update readme and delete vscode settings
1 parent a08e616 commit 488f471

File tree

2 files changed

+25
-7
lines changed

2 files changed

+25
-7
lines changed

.vscode/settings.json

Lines changed: 0 additions & 5 deletions
This file was deleted.

readme.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,41 @@
55
Generates and prints a secure random string (and other types) to terminal.
66

77
## Install
8+
9+
### Using Go
10+
811
Install `go` then run
12+
913
```bash
1014
go install github.com/AmrSaber/random/v3@latest
1115
```
1216

13-
Then you can access the command as `random`.
17+
### Using mise
18+
19+
To install with [mise](https://mise.jdx.dev). First enable experimental features, since Go backend is still experimental.
20+
21+
```bash
22+
mise settings experimental=true
23+
```
24+
25+
The install with
26+
27+
```bash
28+
mise use -g go:github.com/AmrSaber/random/v3@latest
29+
```
30+
31+
Using mise makes it easier to keep updated with the latest versions, you typically update installed packages with `mise up`.
1432

1533
## Usage
34+
35+
However way you use to install the package, it will be available in the CLI as `random`.
36+
1637
After installation, use `random <command>`, you can use `random <command> -h` to show help message related to that command, or use `random -h` to list all the available commands and options.
1738

1839
### Commands
40+
1941
Available commands are [`string`, `pick`, `shuffle`, `id`].
2042

2143
## Feature requests and bug reports
22-
If you have a bug or have a goode idea for a new feature, please [open an issue](https://github.com/AmrSaber/rand-string/issues).
44+
45+
If you have a bug or have a good idea for a new feature, please [open an issue](https://github.com/AmrSaber/rand-string/issues).

0 commit comments

Comments
 (0)