Skip to content

Commit 4e83621

Browse files
authored
Update README.md
1 parent f27db35 commit 4e83621

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,29 @@ puts pix.base64
7777

7878
🚨 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).
7979

80+
## Execute tests/specs
81+
82+
To execute gem tests locally, use Docker with the commands below:
83+
84+
```bash
85+
git clone https://github.com/pedrofurtado/qrcode_pix_ruby
86+
cd qrcode_pix_ruby/
87+
docker build -t qrcode_pix_ruby_specs .
88+
89+
# Then, run this command how many times you want,
90+
# after editing local files, and so on, to get
91+
# feedback from test suite of gem.
92+
docker run -v $(pwd):/app/ -it qrcode_pix_ruby_specs
93+
```
94+
95+
## Demo
96+
97+
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:
98+
99+
https://qrcode-pix-ruby.herokuapp.com
100+
101+
🚨 Important note: The first page load can be slow, because of Heroku free tier. But don't worry, the demo works well 🤓
102+
80103
## Useful links
81104

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

106-
## Execute tests/specs
107-
108-
To execute gem tests locally, use Docker with the commands below:
109-
110-
```bash
111-
git clone https://github.com/pedrofurtado/qrcode_pix_ruby
112-
cd qrcode_pix_ruby/
113-
docker build -t qrcode_pix_ruby_specs .
114-
115-
# Then, run this command how many times you want,
116-
# after editing local files, and so on, to get
117-
# feedback from test suite of gem.
118-
docker run -v $(pwd):/app/ -it qrcode_pix_ruby_specs
119-
```
120-
121-
## Demo
122-
123-
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:
124-
125-
https://qrcode-pix-ruby.herokuapp.com
126-
127-
🚨 Important note: The first page load can be slow, because of Heroku free tier. But don't worry, the demo works well 🤓
128-
129129
## Contributing
130130

131131
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).

0 commit comments

Comments
 (0)