Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 1.86 KB

README.md

File metadata and controls

72 lines (48 loc) · 1.86 KB
Raw

Snitcher

Simple API client for Dead Man's Snitch

Gem Version Build Status Code Climate Coverage Status

Snitches get Stitches

Usage

To check in for one of your snitches:

Snitcher.snitch("c2354d53d2")

You also may provide a message with the check in:

Snitcher.snitch("c2354d53d2", message: "Finished in 23.8 seconds.")

The default timeout of 2 seconds can be overridden:

Snitcher.snitch("c2354d53d2", timeout: 10)

Command Line Tool

You can also check in from the command line:

$ snitch c2354d53d2

If you want to include a message, use the -m or --message flag.

$ snitch c2354d53d2 -m "Finished in 23.8 seconds."
$ snitch c2354d53d2 --message "Finished in 23.8 seconds."

Contributing

Snitcher is open source and contributions from the community are encouraged! No contribution is too small. Please consider:

  • adding features
  • squashing bugs
  • updating documentation
  • fixing typos

For the best chance of having your changes merged, please:

  1. fork the project
  2. push your changes, with tests
  3. submit a pull request with at least one animated GIF

Thanks

A big thank you to Randy Schmidt for dreaming up Dead Man's Snitch in the first place and for entrusting its future to Collective Idea.

Copyright

See LICENSE.txt for details.