README.md in attractor-1.0.2 vs README.md in attractor-1.1.0
- old
+ new
@@ -1,11 +1,27 @@
# Attractor  <img src="https://user-images.githubusercontent.com/4352208/65411858-3dc84200-ddee-11e9-99b6-c9cdbeb533c5.png" width="32">
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
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.
+## Table of Contents
+
+ * [Installation](#installation)
+ * [Usage](#usage)
+ + [Live Reloading](#live-reloading)
+ * [CI Usage](#ci-usage)
+ + [Gitlab Example](#gitlab-example)
+ * [CLI Commands and Options](#cli-commands-and-options)
+ * [Development](#development)
+ * [Contributing](#contributing)
+ * [Social](#social)
+ * [Logo Attribution](#logo-attribution)
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -52,10 +68,33 @@
### 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.
+## CI Usage
+
+To use this CLI in a CI environment, use the `--ci` option, which will suppress automatic opening of a browser window.
+
+### Gitlab Example
+
+The simplest use case is to store the `attractor_output` directory as an artifact.
+
+```yml
+attractor:
+ stage: your-stage-label
+ image: ruby:latest
+ script:
+ - gem install attractor
+ - attractor report --ci
+ artifacts:
+ when: on_success
+ paths:
+ - attractor_output
+```
+
+Alternatively,
+
## CLI Commands and Options
Print a simple output to console:
$ attractor calc
@@ -94,5 +133,24 @@
[Patreon](https://www.patreon.com/user?u=24747270)
## Logo Attribution
[Black Hole by Eynav Raphael from the Noun Project](https://thenounproject.com/term/black-hole/1043893)
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+ <tr>
+ <td align="center"><a href="http://www.julianrubisch.at"><img src="https://avatars0.githubusercontent.com/u/4352208?v=4" width="100px;" alt=""/><br /><sub><b>Julian Rubisch</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor/commits?author=julianrubisch" title="Code">💻</a> <a href="https://github.com/julianrubisch/attractor/commits?author=julianrubisch" title="Documentation">📖</a></td>
+ </tr>
+</table>
+
+<!-- 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