README.md in attractor-0.3.0 vs README.md in attractor-0.3.1

- old
+ new

@@ -1,8 +1,8 @@ # Attractor ![build status](https://travis-ci.org/julianrubisch/attractor.svg?branch=master) -![image](https://user-images.githubusercontent.com/4352208/64156443-1573a600-ce35-11e9-9422-265012e93a91.png) +![image](https://user-images.githubusercontent.com/4352208/65392349-4419d800-dd74-11e9-8dad-d84e21da09e3.png) Many authors ([Michael Feathers](https://www.agileconnection.com/article/getting-empirical-about-refactoring), [Sandi Metz](https://www.sandimetz.com/blog/2017/9/13/breaking-up-the-behemoth)) have shown that an evaluation of churn vs complexity of files in software projects provide a valuable metric towards code quality. This is another take on the matter, for ruby code, using the `churn` and `flog` projects. ## Installation @@ -36,10 +36,22 @@ Watch for file changes: $ attractor report -p app/models --watch +Serve at http://localhost:7890: + + $ attractor serve -p app/models + +Enable rack-livereload: + + $ attractor serve -p app/models --watch + +### Live Reloading + +If you have `guard-livereload` (or a similar service) running on your project, you can leverage the hot reloading functionality by specifying `--watch|-w`. Attractor will then live-reload the browser window when a file watched by `guard-livereload` changes. + ## CLI Commands and Options Print a simple output to console: $ attractor calc @@ -56,18 +68,18 @@ $ attractor serve $ --file_prefix|-p app/models $ --watch|-w -### Live Reloading - -If you have `guard-livereload` (or a similar service) running on your project, you can leverage the hot reloading functionality by specifying `--watch|-w`. Attractor will then live-reload the browser window when a file watched by `guard-livereload` changes. - ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/julianrubisch/attractor. + +## Social + +[Twitter](https://twitter.com/AttractorGem)