README.md in br_danfe-0.5.1 vs README.md in br_danfe-0.5.2

- old
+ new

@@ -82,35 +82,44 @@ By default, your rails application must be configured to `pt-Br`. If you need to customize some message or field label, you can override the content of pt-Br.yml file. -## Development +## Development - With Docker -### Installing dependencies +You needs to build docker container like above: -You can install all necessaries dependencies using bunder like above: + $ docker-compose build - $ bundle install +You can run all RSpec specs using: -### Tests + $ docker-compose run br_danfe rspec -#### Automated tests with RSpec -You can run all specs using: +## Development - Without Docker +You needs to install all necessaries dependencies using bunder like above: + + $ bundle install + + +You can run all RSpec specs using: + $ rspec -If you modify something that caused general visual changes at output pdfs, so you have to rebuild the fixtures pdf files. -You can do this simply deleting the fixture pdf file. The `have_same_content_of` matcher will recreate the fixture in the next time you run the `rspec` command. +## About tests -#### Code coverage +> If you modify something that caused general visual changes at output pdfs, so you have to rebuild the fixtures pdf files. +> +> You can do this simply deleting the fixture pdf file. The `have_same_content_of` matcher will recreate the fixture in the next time you run the `rspec` command. +### Code coverage + Code coverage is available through of SimpleCov. Just run `rspec` and open the coverage report in your browser. -#### Fake data for generating new fixtures +### Fake data for generating new fixtures If you need to generate new danfes for using as fixtures, please don't use real data. These data bellow are suggested: @@ -169,10 +178,10 @@ CNPJ | 71.434.064/0001-49 IE | 964.508.990.089 You can generate new data using [4devs generators](http://www.4devs.com.br). -### Building and publishing +## Building and publishing You can build using one of the above tasks $ rake build # Build br_danfe-X.X.X.gem into the pkg directory $ rake install # Build and install br_danfe-X.X.X.gem into system gems