Project

work-md

0.0
The project is in a healthy, maintained state
Track your work activities, write annotations, recap what you did for a week, month or specific days... and much more!
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Runtime

~> 0.7.0
~> 0.7.0
 Project Readme

Work::Md

Track your work activities, write annotations, recap what you did for a week, month or specific days... and much more!

Installation

With Ruby

Ruby (>= 2.3) must be installed in your machine, then install work-md with:

$ gem install work-md

Usage

Open or create a new work markdown file for today:

$ work-md t

By default, a work markdown file live in [YOUR_HOME_DIRECTORY]/work-md/[YEAR]/[MONTH]/[DAY].md

If no default editor was set in your environment variables work-md will prompt you what editor you want to choose.

You can also set the editor directly in the command call:

$ EDITOR=[YOUR_FAVORITE_EDITOR] work-md

Open or create a new work markdown file for yesterday:

$ work-md y

Open or create a new work markdown file for today and yesterday at same time:

$ work-md ty

Parse your work markdown files:

Day 1 from month 5 and year 2000:

$ work-md p -d=1 -m=5 -y=2000

Day 1, 2 and 3 from the current month and year:

$ work-md p -d=1,2,3

Day 1 and 2 from month 4 and current year:

$ work-md p -d=1,2 -m=4    

Day 1 to 25 from month 2 and current year:

$ work-md p -d=1..25 -m=2    

Day 1 to 25 from month 2 and current year and 1 to 25 from month 2 in 1999:

$ work-md p -d=1..25 -m=2 and -d=1..25 -m=2 -y=1999

Add permanent annotations:

Sometimes we need to keep permanent annotations (not only for a specific day), so we can:

$ work-md a

Configure your preferences:

$ work-md c

This command creates a config.yml file in [YOUR_HOME_DIRECTORY]/work-md (or open, if the file already exists)

We can configure work-md behaviour adding values in the created file, example:

title: Your Name # Title your files
editor: gedit # Your default editor
lang: pt # Your language ('pt', 'en' and 'es' available)

Aliases:

work-md t-> work-md today

work-md y-> work-md yesterday

work-md ty-> work-md tyesterday

work-md p-> work-md parse

work-md a-> work-md annotations

work-md c-> work-md config

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

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

License

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

Code of Conduct

Everyone interacting in the Work::Md project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.