From 70760e1aa37c822b30ad64f8bb7fc5313a1fa5a4 Mon Sep 17 00:00:00 2001 From: Maddie <32415621+SpyHoodle@users.noreply.github.com> Date: Sat, 25 Feb 2023 00:22:48 +0000 Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Made=20README.md=20fancy?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0d07438..07495b9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ -# Agenda -> Rust command-line task manager for nerds. +# Inertia +> Powerful rust command-line task manager. -⚠️ **Warning:** In progress - however somewhat usable at the moment. The name of this project is also subject to change. +## Overview +> **Warning** - In progress and early stages of development. I'm not great with Rust either. + +Inertia is a smart, fast and simple task manager, named after the tendency to do nothing or to remain unchanged (like procrastination.) +It's supposed to be so powerful you won't even be able to think about your inertia any longer. Heh - see what I did there? + +I couldn't find a good task manager, so I'm making one. Basic things to me like the difference between a date you're going to do the task +and a date the task has to be done by are missing in so many task managers. They seem to take the approach of you write down what you do +and then have to think about it every time you read your tasks! You should be able to take the stress away from tasks by writing everything +down once so that you can come back to it knowing exactly what to do. + +## Features +- [X] Separate when and deadline dates +- [ ] Show next `n` tasks that you should do +- [ ] Separate areas for tasks +- [ ] Linking tasks together +- [ ] A proper tagging system +- [ ] Git synchronization + +## Examples +**Creating a task** - which you will do it today, deadline tomorrow +```sh +inertia add "read emails" -w now -d tomorrow +``` +**Deleting a task** - with ID 8 +```sh +inertia del 8 +``` +**Show all tasks** +```sh +inertia show +```