Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
siripr4 committed Feb 18, 2023
1 parent ed339f0 commit dd9903f
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,36 @@
# UUID CLI
# UUID CLI

A simple tool to generate uuid with a cli command
A simple tool to generate uuid with a cli command.

Generates a random (Version 4) UUID and prints to stdout.

Underlying library: https://pkg.go.dev/github.com/google/uuid

## Installation

_TODO_
**1. Manually build**

1. Clone the repo

```git clone https://github.com/siripr4/uuid-cli.git```

2. cd to the directory

```cd uuid-cli```

3. Build the go file

```go build . -o uuid```

4. Run the binary

```./uuid```

5. Optionally, add the binary to your PATH to generate uuid from anywhere. Symlink the binary to `usr/local/bin`

```sudo ln -s <absolute-path-to-binary> /usr/local/bin/uuid```

**2. Install via homebrew**

_TODO_

0 comments on commit dd9903f

Please sign in to comment.