Skip to content

Commit

Permalink
remove travis ci badge
Browse files Browse the repository at this point in the history
  • Loading branch information
danmayer committed Dec 5, 2020
1 parent 5a34d02 commit 33205b5
Showing 1 changed file with 20 additions and 19 deletions.
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
[![Build Status](https://travis-ci.org/danmayer/churn.svg?branch=master)](http://travis-ci.org/danmayer/churn)

CI: [![Build Status](https://github.com/danmayer/churn/workflows/CI/badge.svg)](https://github.com/danmayer/churn/actions)

# Churn

A Project to give the churn file, class, and method for a project for a given checkin. Over time the tool adds up the history of churns to give the number of times a file, class, or method is changing during the life of a project.
Expand All @@ -17,7 +19,6 @@ Want to help out, there are easy tasks ready for some attention. The list of ite

Install with `gem install churn` or for bundler add to your Gemfile


```
group :development do
gem 'churn'
Expand All @@ -26,21 +27,21 @@ end

### Rake

* Add `require 'churn'` to Rakefile
* Then run `rake churn` or `bundle exec rake churn`
* Use environment variables to control churn defaults
- Add `require 'churn'` to Rakefile
- Then run `rake churn` or `bundle exec rake churn`
- Use environment variables to control churn defaults

``` ruby
```ruby
ENV['CHURN_MINIMUM_CHURN_COUNT']
ENV['CHURN_START_DATE']
ENV['CHURN_IGNORES']
```

### CLI

* On the command line run `churn` or `bundle exec churn`
* Need help? Run `churn -h` to get additional information
* Run the executable, passing in options to override defaults
- On the command line run `churn` or `bundle exec churn`
- Need help? Run `churn -h` to get additional information
- Run the executable, passing in options to override defaults

```shell
churn -i "churn.gemspec, Gemfile" # Ignore files
Expand Down Expand Up @@ -170,22 +171,22 @@ result = Churn::ChurnCalculator.new(options).report(false)

## Notes on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
- Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but
bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
bump version in a commit by itself I can ignore when I pull)
- Send me a pull request. Bonus points for topic branches.

## Authors

* danmayer
* ajwalters
* cldwalker
* absurdhero
* bf4
- danmayer
- ajwalters
- cldwalker
- absurdhero
- bf4

## Code of Conduct

Expand Down

0 comments on commit 33205b5

Please sign in to comment.