Skip to content

Commit c0b3930

Browse files
committed
Readme
1 parent 0c7e7ca commit c0b3930

File tree

1 file changed

+33
-19
lines changed

1 file changed

+33
-19
lines changed

README.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,46 @@
22

33
<p align="center"><img alt="pix-utils" src="https://raw.githubusercontent.com/thiagozs/go-pixgen/main/assets/logo-pix.png" width="128px" /></p>
44

5-
generate and validate payments of Brazil Instant Payment System (Pix), making fast and simple to handle charges and proccess then in your project.
5+
Generate ~~and validate~~ payments of Brazil Instant Payment System (Pix), making fast and simple to handle charges and proccess then in your project.
66

77
**UNDER DEVELOPMENT** *** Not ready for production
88

99
Example implementation.
1010
```golang
11-
opts := []pix.Options{
12-
pix.OptPixKey("11955555555"),
13-
pix.OptDescription("Teste"),
14-
pix.OptMerchantName("Thiago Zilli Sarmento"),
15-
pix.OptMerchantCity("Ararangua"),
16-
pix.OptAmount("0.00"),
17-
pix.OptKind(pix.STATIC),
18-
}
19-
20-
p, err := pix.New(opts...)
21-
if err != nil {
22-
panic(err)
23-
}
24-
cpy := p.GenPayload()
25-
if err != nil {
26-
panic(err)
27-
}
28-
fmt.Println(cpy)
11+
opts := []pix.Options{
12+
pix.OptPixKey("11955555555"),
13+
pix.OptDescription("Teste"),
14+
pix.OptMerchantName("Thiago Zilli Sarmento"),
15+
pix.OptMerchantCity("Ararangua"),
16+
pix.OptAmount("0.00"),
17+
pix.OptKind(pix.STATIC),
18+
}
19+
20+
p, err := pix.New(opts...)
21+
if err != nil {
22+
panic(err)
23+
}
24+
cpy := p.GenPayload()
25+
if err != nil {
26+
panic(err)
27+
}
28+
fmt.Println(cpy)
2929
```
3030

31+
## Roadmap
32+
33+
- [x] Generate payments based on parameters
34+
- [x] Static
35+
- [x] Dynamic
36+
- [ ] Parse and validate EMV Codes
37+
- [ ] Export generated/parsed payment to Image
38+
- [x] Export generated/parsed payment to EMV Code
39+
- [ ] Fetch, parse and validate remote payloads from dynamic payments
40+
- [ ] Verify if has already expired
41+
- [ ] Improve tests
42+
- [ ] Doccumentation with all methods, parameters and some examples
43+
- [ ] Add dynamic payment tests
44+
3145
## Contributing
3246

3347
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/thiagozs/go-genpix/compare).

0 commit comments

Comments
 (0)