Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
AgumasD opened this issue Dec 24, 2024 · 0 comments · May be fixed by #446
Open

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

AgumasD opened this issue Dec 24, 2024 · 0 comments · May be fixed by #446

Comments

@AgumasD
Copy link

AgumasD commented Dec 24, 2024

The current "Usage" section in the README.md provides minimal examples for many commands. This makes it harder for new users to understand how to use certain features of todo.txt-cli effectively, especially for commands like list, replace, and move.

Proposed Solution:
Expand the "Usage" section with more detailed and practical examples for commands. Examples should showcase real-world scenarios and highlight edge cases where applicable. This will improve clarity and usability for both new and experienced users.

Suggested Additions:

Add examples for filtering tasks using list with multiple terms.
Include a practical example for replacing a task using replace.
Provide an example for moving tasks between files with the move command.
Add detailed examples for other frequently used commands like pri and append.

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 a pull request may close this issue.

1 participant