https://github.com/bodacious/daily_log
Simple command-line tool for logging daily process on a project
https://github.com/bodacious/daily_log
Last synced: 11 days ago
JSON representation
Simple command-line tool for logging daily process on a project
- Host: GitHub
- URL: https://github.com/bodacious/daily_log
- Owner: Bodacious
- License: mit
- Created: 2020-01-06T17:15:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-07T09:54:36.000Z (over 6 years ago)
- Last Synced: 2025-02-24T09:47:03.427Z (over 1 year ago)
- Language: Ruby
- Size: 49.8 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# DailyLog
Provides a simple framework for keeping a daily log of the work you do on a project
## Usage
Call the binary `dl` to open today's log.
Pass in the option `--help` to see the other options available.
## Installation
``` bash
gem install daily_log
```
## Example
At the end of a working day, you run from your console
``` bash
$ dl
```
This opens a text file in your editor that looks like this:
``` text
# Daily Entry - Wed 01 January, 2020
## Today I worked on:
- Thing one
## Next time, you should continue with:
- Thing two
## Notes:
Some optional notes here...
```
You edit the file to say:
``` text
# Daily Entry - Wed 01 January, 2020
## Today I worked on:
- Adding two-factor authentication for admins
## Next time, you should continue with:
- Password management for admins
## Notes:
We need to rethink how we handle password resets when user has 2FA enabled
```
### A few days later
Some time has passed since you last worked on the project. You aren't quite sure where to pick up from the last time you worked on it.
You type:
```
$ dl -l # short for dl --last
```
...to print out your log to the console.
## Why bother?
Managing a log file like this can help you keep your train of thought when interrupted on a project for a few days or longer.
This is a simple, non-invasive way to leave notes to your future self.
It's also a great way to take full stock of a project once it's complete. Were your time estimates as accurate as you thought they would be?