# Digital Logbook---A command line application for tracking your
# computer usage times.

# Copyright (C) 2023 Max Günther

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

#+TITLE: Digital Logbook
#+OPTIONS: toc:nil
#+export_file_name: CARGO_README.md

Digital Logbook---A command line application for tracking your
computer usage times.  Currently under development.

* Features

** Already implemented

 - Creating an entry
 - Finishing an entry
 - Displaying report of today (currently WIP)

** Upcoming

 - Showing already finished entries
 - Filter for finished entries

* Walkthrough

Please note that due to being in development some commands have not
been implemented yet.

#+begin_src shell
  $ # Display the help menu.
  $ logbook
  $ logbook help
  $ logbook -h
  $ logbook --help
  $
  $ # Create an entry.
  $ logbook create
  $ # Overwrite an unfinished entry.
  $ logbook create -f
  $
  $ # Finish an entry.
  $ logbook finish
  $ # With description.
  $ logbook finish --description "Hello World!"
  $
  $ # Display report.
  $ logbook report
  $
  $ # Showing already finished entries.
  $ logbook show
  $ logbook show --date 2023-12-21
  $ logbook show --description "Hello World!"
#+end_src