Skip to content

Commit 8a55c77

Browse files
authored
Merge pull request #18 from elasticrash/O.2.5
0.2.5 spawnflake-cli tool
2 parents e55bf18 + dad0aaa commit 8a55c77

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

cli/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# 🐙❄️ Spawnflake(s)
22

33
This is the cli tool the loyal companion of the spanwflake libary
4+
It should work on both windows and linux (mostly tested in linux)
45

5-
## USAGE
6+
## Usage
67

78
```
8-
spawnflakes.exe [OPTIONS]
9+
spawnflake-cli[.exe] [OPTIONS]
910
1011
FLAGS:
1112
-h, --help Prints help information
@@ -19,5 +20,9 @@ OPTIONS:
1920
```
2021
example
2122
```
22-
spawnflakes.exe -s 4 -c ..\config.json
23-
```
23+
spawnflake-cli[.exe] -s 4 -c ..\config.json
24+
```
25+
26+
## Installing
27+
* You can build it from source by cloning this repo and running `cargo build --release`
28+
* Or you can install it directly from crates.io Just do `cargo install spawnflake-cli`. In this case, though, make sure that `~/.cargo/bin/` is in your PATH variable

0 commit comments

Comments
 (0)