Skip to content

Commit

Permalink
Updated readme with example and repo badges
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnAkerman committed Dec 9, 2019
1 parent a752613 commit eb77a6c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<h1 align="center">Git Out Of Hours</h1>

> View commit information on out of hours commits on a repo
<p align="center">
<a href="https://github.com/JohnAkerman/GitOutOfHours/blob/master/LICENSE"><img src="https://img.shields.io/github/license/JohnAkerman/GitOutOfHours.svg" alt="GitHub license"></a> <a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard - JavaScript Style Guide"></a>
<a href="https://github.com/JohnAkerman/GitOutOfHours/blob/master/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/JohnAkerman/GitOutOfHours"></a>
<img src="https://img.shields.io/github/languages/top/JohnAkerman/GitOutOfHours" alt="Top Language" />
<a href="https://snyk.io/test/github/JohnAkerman/GitOutOfHours"><img src="https://snyk.io/test/github/JohnAkerman/GitOutOfHours/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/JohnAkerman/GitOutOfHours" style="max-width:100%;"></a>
</p>
View commit information on out of hours commits on a repo



## Install
Expand All @@ -17,14 +19,15 @@ $ npm i -g gitoutofhours
## Usage
After you've installed `gitoutofhours` globally you will be able to run it as a CLI application using the command line.
```
$ gitoutofhours [daysInPast] [author](optional)
$ gitoutofhours [daysInPast] [author](optional, in quotes)
```


Basic usage to establish how many commits were out of hours in the past week
```
$ gitoutofhours 7
```
<img src="media/example-usage.png" alt="Command prompt output showing git commits in a table" />

## Purpose
This tool can help gather information about repos where teh author commited work out of common office hours (between 5:30pm to 8:30am).
Binary file added media/example-usage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit eb77a6c

Please sign in to comment.