Skip to content

Conversation

@AgumasD
Copy link
Contributor

@AgumasD AgumasD commented Dec 24, 2024

Summary of Changes

This PR improves the "Usage" section of the README.md by adding detailed examples for several commands. These examples aim to provide practical use cases to help users better understand and utilize todo.txt-cli.

Changes Made

  1. Added an example for the list command with filters and logical operators.
  2. Included a practical example for replace, showcasing how to update an existing task.
  3. Detailed the move command with a clear explanation of SRC and DEST arguments and an example.
  4. Added examples for prioritizing tasks using pri and appending text to tasks with append.

Why This Change is Needed

The previous documentation provided only minimal examples, making it harder for users to grasp the full functionality of the commands. By adding these detailed examples, we aim to improve the onboarding experience for new users and enhance the usability of the tool.

Fixes #445

@karbassi karbassi merged commit f00ee90 into todotxt:master Dec 25, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Detailed Examples to the "Usage" Section in README.md

2 participants