Build Status Code Climate Test Coverage Issue Count Gem Version Yard Docs DUB

Complish

Keep a meaningful journal of the work you've done.

Inspired by a tweet from @tenderlove.

Keeping track of the work you do from day to day can be a job in itself. Complish aims to alleviate some of that struggle by providing an easy way for you to keep a journal of the various things you do throughout the day. When it's time for your annual review with your boss, or simply time for your end of sprint retrospective, Complish will make sure you're ready to tell the team what you've accomplished.

Features

TODO: list the feature set of Complish.

Planned Features:

  • #25 - Install a git alias or a post-commit-hook to automatically log journal entries as soon as you commit code.

Installation

Add this line to your application's Gemfile:

gem 'complish'

And then execute:

$ bundle

Or install it yourself as:

$ gem install complish

Development

This gem is in super early alpha at the moment there's not a whole lot here yet.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/aaronmallen/complish. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.