Skip to content

Commit

Permalink
add project description.
Browse files Browse the repository at this point in the history
  • Loading branch information
overcat committed Mar 14, 2021
1 parent 0b03ecb commit 2105030
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
# stellar-identicon-go
# Stellar Identicon Generator (Golang)

The go implementation of [SEP-0033](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0033.md),
which you can use to generate identicons for Stellar wallets - unique icons, generated based on the wallet public key.

## Install
```shell
go get -u github.com/overcat/stellar-identicon-go
```

## Usage
```go
import identicon "github.com/overcat/stellar-identicon-go"

func main() {
publicKey := "GAQL4ZLRIJBGSCXE6XC4XPZ5W6FGCJHXLAMB4M7ZQ52HFPDTL6GSVP4W"
img, err := identicon.Generate(publicKey, identicon.Width, identicon.Height)
if err != nil {

}
}
```

## Thanks
This project was inspired by [LOBSTR](https://github.com/Lobstrco).

0 comments on commit 2105030

Please sign in to comment.