Skip to content

Commit 2105030

Browse files
committed
add project description.
1 parent 0b03ecb commit 2105030

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
# stellar-identicon-go
1+
# Stellar Identicon Generator (Golang)
2+
3+
The go implementation of [SEP-0033](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0033.md),
4+
which you can use to generate identicons for Stellar wallets - unique icons, generated based on the wallet public key.
5+
6+
## Install
7+
```shell
8+
go get -u github.com/overcat/stellar-identicon-go
9+
```
10+
11+
## Usage
12+
```go
13+
import identicon "github.com/overcat/stellar-identicon-go"
14+
15+
func main() {
16+
publicKey := "GAQL4ZLRIJBGSCXE6XC4XPZ5W6FGCJHXLAMB4M7ZQ52HFPDTL6GSVP4W"
17+
img, err := identicon.Generate(publicKey, identicon.Width, identicon.Height)
18+
if err != nil {
19+
20+
}
21+
}
22+
```
23+
24+
## Thanks
25+
This project was inspired by [LOBSTR](https://github.com/Lobstrco).

0 commit comments

Comments
 (0)