Giter VIP home page Giter VIP logo

crusoe's Introduction

Crusoe

Ruby

A simple daily work journal from your command-line

# Open today's journal and add to it
$ crusoe
crusoe help
Commands:
  crusoe help [COMMAND]  # Describe available commands or one specific command
  crusoe journal         # This is the default task.
  crusoe read            # Read an entry
  crusoe report          # Generate a report for the last week
  crusoe toc             # Update the ToC on the README.md

Installation

gem install crusoe

Feature list

Write to journal

crusoe journal ✅

  • Write a single journal entry for given day (defaults to today)
  • Automatically saves to git repo configured by you
  • Default command for crusoe
  • Can provide an optional --date value (e.g. one of "today", "yesterday", "2023-12-25")

crusoe read ✅

  • Read a single journal entry for given day (defaults to today)
  • Can provide an optional --date value (e.g. one of "today", "yesterday", "2023-12-25")

crusoe report ✅

  • Print the entries from the current week

Organise journal in the README 🏗

  • WIP: Keep an up-to-date index of all entries in the README

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/bodacious/crusoe.

License

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

crusoe's People

Contributors

bodacious avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.