README.md in face_control-0.8.3 vs README.md in face_control-0.8.4
- old
+ new
@@ -4,20 +4,24 @@
[![Coveralls](https://img.shields.io/coveralls/vassilevsky/face_control.svg)](https://coveralls.io/github/vassilevsky/face_control)
[![VersionEye](https://img.shields.io/versioneye/d/ruby/face_control.svg)](https://www.versioneye.com/ruby/face_control)
# Face Control
-Comment on added lines of pull requests in [Atlassian Stash][].
-Take comments from static checkers reports.
-(Currently supports [RuboCop][] and [CoffeeLint][].)
+Run static analysis of pull requests in [Bitbucket Server][] (formerly Stash)
+and comment on problems in added lines.
+Currently supports [RuboCop][] and [CoffeeLint][] and also checks for
+TODOs and FIXMEs.
+
Inspired by [Hound][].
## Installation
gem install face_control
+You also need to have CoffeeLint installed and available in PATH.
+
## Usage
face-control <project> <repository> <pull_request_id>
It's natural to run this on a continuous integration server.
@@ -59,19 +63,19 @@
You can also pass multiple severity levels as a comma-separated list:
face-control -S convention,refactor <project> <repository> <pull_request_id>
`face-control` uses the same configuration file (`~/.stashconfig.yml`)
-as the official [Atlassian Stash Command Line Tools][]
+as the official [Bitbucket Server Command Line Tools][]
to connect to your Stash instance.
## Etymology
[Face control][] in Wikipedia
[Hound]: https://houndci.com
-[Atlassian Stash]: https://www.atlassian.com/software/stash
-[Atlassian Stash Command Line Tools]: https://bitbucket.org/atlassian/stash-command-line-tools
+[Bitbucket Server]: https://www.atlassian.com/software/bitbucket/server
+[Bitbucket Server Command Line Tools]: https://bitbucket.org/atlassian/bitbucket-server-cli
[RuboCop]: http://batsov.com/rubocop/
[CoffeeLint]: http://www.coffeelint.org
[Jenkins]: http://jenkins-ci.org
[Face control]: http://en.wikipedia.org/wiki/Face_control