Skip to content

Commit

Permalink
Add installation instructions to README (#41)
Browse files Browse the repository at this point in the history
Add installations instructions to both `typeid` and `tyson` README
files.
  • Loading branch information
loreto authored Jun 27, 2023
1 parent bef82f5 commit 1dd3cc8
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,28 +43,28 @@ We are looking for community contributions to implement TypeIDs in other languag
## Command-line Tool
This repo includes a command-line tool for generating TypeIDs. To install it, run:

```
go install github.com/jetpack-io/typeid
```bash
curl -fsSL https://get.jetpack.io/typeid | bash
```

To generate a new TypeID, run:

```
```console
$ typeid prefix
prefix_01h2xcejqtf2nbrexx3vqjhp41
```

To decode an existing TypeID into a UUID run:

```
```console
$ typeid decode prefix_01h2xcejqtf2nbrexx3vqjhp41
type: prefix
uuid: 0188bac7-4afa-78aa-bc3b-bd1eef28d881
```

And to encode an existing UUID into a TypeID run:

```
```console
$ typeid encode prefix 0188bac7-4afa-78aa-bc3b-bd1eef28d881
prefix_01h2xcejqtf2nbrexx3vqjhp41
```
Expand Down

0 comments on commit 1dd3cc8

Please sign in to comment.