Skip to content

Commit

Permalink
Update readme (pluralsight#11)
Browse files Browse the repository at this point in the history
* Remove mention of old integration tests

* Rename an mention fork source

* Remove motivation, add contributing section

* Link to releases

* Add reasons for forking

* Refer to "mob-timer" consistently

* Add licence shield

* Add contributors shield

* Add master build shield

* Add download count shield

* Add Github open "idea" issues shield

* Add github release version shield
  • Loading branch information
Daniel Ignat authored Mar 11, 2019
1 parent ca1b262 commit 220f97c
Showing 1 changed file with 35 additions and 22 deletions.
57 changes: 35 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
# Pluralsight Mob Timer

[![Greenkeeper badge](https://badges.greenkeeper.io/mob-timer/mob-timer.svg)](https://greenkeeper.io/)

A cross-platform timer built on [Electron](http://electron.atom.io/)
for doing [Mob Programming](http://mobprogramming.org/)
# Mob Timer

[![GitHub release](https://img.shields.io/github/release/mob-timer/mob-timer.svg)](https://github.com/mob-timer/mob-timer/releases)
[![Greenkeeper badge](https://badges.greenkeeper.io/mob-timer/mob-timer.svg)](https://greenkeeper.io/)
[![License](https://img.shields.io/github/license/mob-timer/mob-timer.svg)](LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/mob-timer/mob-timer.svg)](https://github.com/mob-timer/mob-timer/graphs/contributors)
[![Travis (.org)](https://img.shields.io/travis/mob-timer/mob-timer/master.svg)](https://travis-ci.org/mob-timer/mob-timer/branches)
![GitHub All Releases](https://img.shields.io/github/downloads/mob-timer/mob-timer/total.svg)
[![GitHub open idea issues](https://img.shields.io/github/issues-raw/mob-timer/mob-timer/idea.svg?color=blue)](https://github.com/mob-timer/mob-timer/issues?q=is%3Aissue+is%3Aopen+label%3Aidea)

A cross-platform mob-timer built on [Electron](http://electron.atom.io/)
for doing [Mob Programming](http://mobprogramming.org/). This is a fork from [pluralsight/mob-timer](https://github.com/pluralsight/mob-timer).

![Example Timer Image](timer-example.png)

Click the gear icon in the top right to configure the timer.
Then click the large circle to start/stop the timer,
Click the gear icon in the top right to configure the mob-timer.
Then click the large circle to start/stop the mob-timer,
or the smaller circle to skip to the next mobber.

# Running the mob-timer

You can either build the mob-timer from source or [download a pre-built version](https://github.com/mob-timer/mob-timer/releases).

## Build mob-timer

# Build the timer
Run `npm install` and then one of the following commands for your respective operating system:
- Windows: `npm run build-win`
- Mac OS X: `npm run build-mac`
Expand All @@ -23,25 +33,28 @@ If you need a platform other than these, you will need to modify the build scrip


# Development

Run `npm install` to get the dependencies, then `npm start` to run the timer.
Run `npm test` to start the unit tests, or `npm run integration_test` to run integration tests.
Run `npm test` to run the unit tests once, or alternatively `npm run watch` to run them on changes.


# Contributing

Feel free to open Issues and Pull Requests discussing additions to this project. You can also have a look at the [existing issues](https://github.com/mob-timer/mob-timer/issues). Keep the Pull Requests small and make sure the tests and code style checks pass.

# Motivation
Pluralsight has a development team that does mob programming full-time,
and a few other teams dabble in mobbing as well.
We have tried and enjoyed a number of other mob timers, but we had various
(mostly minor) gripes with them.
So we decided to build one of our own.
If you are uncertain, please reach out first (by opening an issue) before investing too much time. :)

We had a few goals:
# Reasons for forking

* Make a timer that is hard to ignore, but also not overly annoying
* Implement escalating alerts
* Customization
* Have a timer that we can easily hack on, built with tech we know
_This is a fork from [pluralsight/mob-timer](https://github.com/pluralsight/mob-timer), please have a look to see if that project is more suited to your needs!_ 🙂

There are a few main reasons for this fork existing:

- To build in CI and attach to release using [Travis CI](https://travis-ci.org/)
- To stay up to date with dependencies using [Greenkeeper.io](https://greenkeeper.io/)
- To move to code style and tooling suited for project, not needing to take internal company best practices into account
- To have an independent organization where the mob-timer is the focus

# License

The Pluralsight Mob Timer is licensed under the [Apache 2.0 license](LICENSE).
The Mob Timer is licensed under the [Apache 2.0 license](LICENSE).

0 comments on commit 220f97c

Please sign in to comment.