Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrofurtado authored Jul 10, 2021
1 parent f27db35 commit 4e83621
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,29 @@ puts pix.base64

🚨 Important note: BACEN (Banco Central do Brasil) sets a variety of rules for each field in QRCode Payload (maximum number of characters, invalid values, mandatory and optional fields, and so on). So, pay attention that a QRCode payload+base64 generated by the gem can be valid, theorically, but may not be accepted in banking apps because of these restrictions (that are out of scope of gem).

## Execute tests/specs

To execute gem tests locally, use Docker with the commands below:

```bash
git clone https://github.com/pedrofurtado/qrcode_pix_ruby
cd qrcode_pix_ruby/
docker build -t qrcode_pix_ruby_specs .

# Then, run this command how many times you want,
# after editing local files, and so on, to get
# feedback from test suite of gem.
docker run -v $(pwd):/app/ -it qrcode_pix_ruby_specs
```

## Demo

It's provided a simple demo app, in Heroku, that uses the gem always in latest commit. You can check and test your QRCodes here:

https://qrcode-pix-ruby.herokuapp.com

🚨 Important note: The first page load can be slow, because of Heroku free tier. But don't worry, the demo works well 🤓

## Useful links

* https://github.com/joseviniciusnunes/qrcode-pix
Expand All @@ -103,29 +126,6 @@ puts pix.base64
* https://github.com/jesobreira/pixkey
* https://github.com/pedrinholemes/pix-br

## Execute tests/specs

To execute gem tests locally, use Docker with the commands below:

```bash
git clone https://github.com/pedrofurtado/qrcode_pix_ruby
cd qrcode_pix_ruby/
docker build -t qrcode_pix_ruby_specs .

# Then, run this command how many times you want,
# after editing local files, and so on, to get
# feedback from test suite of gem.
docker run -v $(pwd):/app/ -it qrcode_pix_ruby_specs
```

## Demo

It's provided a simple demo app, in Heroku, that uses the gem always in latest commit. You can check and test your QRCodes here:

https://qrcode-pix-ruby.herokuapp.com

🚨 Important note: The first page load can be slow, because of Heroku free tier. But don't worry, the demo works well 🤓

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pedrofurtado/qrcode_pix_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pedrofurtado/qrcode_pix_ruby/blob/master/CODE_OF_CONDUCT.md).
Expand Down

0 comments on commit 4e83621

Please sign in to comment.