Skip to content

Commit

Permalink
Update README.md with install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
contrick64 authored Apr 4, 2024
1 parent e8098cf commit d97a92c
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# Daily Journal

`daily.py` is a command-line utility for managing a daily journal. It provides several functionalities such as creating a new entry, adding to an existing entry, wrapping text, and opening the journal in an editor.
`daily.py` is a command-line utility for managing a daily journal. It provides several functionalities
such as creating a new entry, adding to an existing entry, wrapping text, and opening the journal in
an editor.

## Installation

`daily-diary` currently requires python3.10 or higher. The reasoning for this is silly, and should
change, I think. I'll get to it eventually.

I recommend installing with pipx. You can run the same command with pip instead.
```bash
pipx install daily-diary
```
Currently there is no way to configure the location of your diary, it will go in `~/notes/daily/`.

## Usage

Expand All @@ -15,12 +28,10 @@ The available commands are:
- `add`: Add an entry inline. Requires the -m/--mood and -e/--entry options.
- `edit`: Edit today's entry without adding any headers.

The available options are:

- `-w/--wrap-file`: Wrap the entire contents of today's file.
for any command:
- `-w/--wrap-file`: Wrap the entire contents of today's file after editing.

For the add command, these are required:

- `-m/--mood`: The mood character and word(s) to be included, like `+ motivated joyous`
- `-e/--entry`: The text to be entered into your diary.

Expand All @@ -30,4 +41,4 @@ This is the first repository I am creating with the intent of inviting contribut
I will also accept suggestions on how best to accept suggestions...

## License
This project is licensed under the GPLv3 License.
This project is licensed under the GPLv3 License.

0 comments on commit d97a92c

Please sign in to comment.