Update README and help message. Bump to version 1.1.0

Remove Getting started section because mdt works out of the box now.
Move some configuration examples from Getting started to Configuration
section.

Author: basilioss

README.md

@@ -17,14 +17,14 @@
 
 ## :package: Dependencies
 
-- POSIX-compliant shell (sh, dash, bash etc.)
+- POSIX-compliant shell (dash, bash, zsh etc.)
 - [gum](https://github.com/charmbracelet/gum#installation)
 
 ## :rocket: Installation
 
 ### Install as a package
 
-`mdt` is available in the [Arch User Repository](https://aur.archlinux.org/packages/mdt). If you use Arch or an Arch-based distro, you can use `makepkg` or your AUR helper of choice to install the `mdt` package.
+mdt is available in the [Arch User Repository](https://aur.archlinux.org/packages/mdt). If you use Arch or an Arch-based distro, you can use `makepkg` or your AUR helper of choice to install the `mdt` package.
 
 ### Install using `make`
 
@@ -45,42 +45,35 @@ chmod +x mdt
 mv mdt ~/.local/bin
 ```
 
-## :memo: Getting started
-
-1. Create a todo lists directory:
+## :gear: Configuration
 
-```sh
-mkdir ~/tasks
-```
+| Option        | Environment Variable  | Description                                                            |
+| ------------  | --------------------- | ---------------------------------------------------------------------- |
+| -d, --dir     | MDT_DIR               | Path to the tasks directory. By default the current working directory. |
+| -i, --inbox   | MDT_INBOX             | Path to the inbox file. By default "todo.md".                          |
+| --color       | MDT_MAIN_COLOR        | Main color.                                                            |
+| --prompt      | MDT_PROMPT            | Input prompt character. Default is '◆'.                                |
+| --cursor      | MDT_CURSOR            | Selection character. Default is '➔'.                                   |
+| --item-width  | MDT_ITEM_WIDTH        | Todo items width. 0 for no wrap, default is 75.                        |
+| --input-width | MDT_INPUT_WIDTH       | Input prompt width. 0 for no wrap, default is 65.                      |
+| --editor      | MDT_EDITOR, EDITOR    | Markdown file editor.                                                  |
 
-2. Create an inbox:
+Examples of using options:
 
 ```sh
-touch ~/tasks/inbox.md
+# Static path to the inbox
+alias mdt='mdt --dir ~/tasks --inbox ~/tasks/inbox.md'
+# Dynamic path to the inbox
+alias mdt='mdt --dir ~/tasks --inbox ~/tasks/"$(date -I).md"'
 ```
 
-3. Create an alias to run `mdt`. Put something like this in your `~/.bashrc` file:
+Examples of using environment variables:
 
 ```sh
-alias mdt='mdt --dir ~/tasks --inbox ~/tasks/inbox.md'
+export MDT_MAIN_COLOR='#5FAFFF'
+export MDT_EDITOR='nvim -c "set nonumber"'
 ```
 
-4. Reload your `.bashrc` by running `source ~/.bashrc` or just restart the terminal window.
-5. In case you want to edit markdown files manually, check out this site: https://www.markdownguide.org/cheat-sheet
-
-## :gear: Configuration
-
-| Option        | Environment Variable  | Description                                       |
-| ------------  | --------------------- | ------------------------------------------------- |
-| -d, --dir     | MDT_DIR               | Path to the tasks directory.                      |
-| -i, --inbox   | MDT_INBOX             | Path to the inbox file.                           |
-| --color       | MDT_MAIN_COLOR        | Main color.                                       |
-| --prompt      | MDT_PROMPT            | Input prompt character. Default is '◆'.           |
-| --cursor      | MDT_CURSOR            | Selection character. Default is '➔'.              |
-| --item-width  | MDT_ITEM_WIDTH        | Todo items width. 0 for no wrap, default is 75.   |
-| --input-width | MDT_INPUT_WIDTH       | Input prompt width. 0 for no wrap, default is 65. |
-| --editor      | MDT_EDITOR, EDITOR    | Markdown file editor.                             |
-
 ## :keyboard: Keybindings
 
 | Keybinding                   | Description         |
@@ -90,3 +83,4 @@ alias mdt='mdt --dir ~/tasks --inbox ~/tasks/inbox.md'
 | Tab/Space/x                  | Select              |
 | a/A                          | Select/unselect all |
 | Enter                        | Accept              |
+

mdt

@@ -15,7 +15,7 @@ file_editor="${MDT_EDITOR:-${EDITOR}}"
 ################################################
 
 _me="${0##*/}"
-_mdt_version="1.0.1"
+_mdt_version="1.1.0"
 
 print_help()
 {
@@ -28,8 +28,15 @@ Usage
   [--input-width <arg>] [--editor <arg>] [--version] [-h|--help]
 
 Options
-  -d, --dir           Path to the todos directory
-  -i, --inbox         Path to the inbox note
+  -d, --dir           Path to the tasks directory
+  -i, --inbox         Path to the inbox file
+  --color             Main color
+  --prompt            Input prompt character
+  --cursor            Selection character
+  --item-width        Todo items width
+  --input-width       Input prompt width
+  --editor            Markdown file editor
+  --version           Print version
   -h, --help          Print help
 "
 exit 0