README.md in attractor-1.1.0 vs README.md in attractor-1.1.1

- old
+ new

@@ -5,16 +5,19 @@ ![attractor_v0 6 1](https://user-images.githubusercontent.com/4352208/67033292-b41e4280-f115-11e9-8c91-81b3bea4451c.gif) 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. +Here's an [article on medium](https://medium.com/better-programming/why-i-made-my-own-code-quality-tool-c44b40ceaafd) explaining the approach in greater detail. + ## Table of Contents * [Installation](#installation) * [Usage](#usage) + [Live Reloading](#live-reloading) * [CI Usage](#ci-usage) + + [Github Action](#github-action) + [Gitlab Example](#gitlab-example) * [CLI Commands and Options](#cli-commands-and-options) * [Development](#development) * [Contributing](#contributing) * [Social](#social) @@ -72,10 +75,14 @@ ## CI Usage To use this CLI in a CI environment, use the `--ci` option, which will suppress automatic opening of a browser window. +### Github Action + +There is a dedicated [Github Action](https://github.com/julianrubisch/attractor-action) that will compile Attractor's output. Here's the action on the [Marketplace](https://github.com/marketplace/actions/attractor-action). + ### Gitlab Example The simplest use case is to store the `attractor_output` directory as an artifact. ```yml @@ -99,25 +106,31 @@ $ attractor calc $ --file_prefix|-p app/models $ --type|-t rb|js $ --watch|-w + $ --start_ago|-s (e.g. 5y, 3m, 7w) + $ --minimum_churn|-c (minimum times a file must have changed to be processed) Generate a full report $ attractor report $ --file_prefix|-p app/models $ --type|-t rb|js $ --watch|-w $ --no-open-browser|--ci + $ --start_ago|-s (e.g. 5y, 3m, 7w) + $ --minimum_churn|-c (minimum times a file must have changed to be processed) Serve the output on http://localhost:7890 $ attractor serve $ --file_prefix|-p app/models $ --watch|-w $ --no-open-browser|--ci + $ --start_ago|-s (e.g. 5y, 3m, 7w) + $ --minimum_churn|-c (minimum times a file must have changed to be processed) ## 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. @@ -151,6 +164,6 @@ <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END --> -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!