From 48a43dbc98471ebd63d1e3e3d2576623ad25e4ef Mon Sep 17 00:00:00 2001 From: Louison SARLIN--MAGNUS Date: Fri, 3 Apr 2026 22:48:02 +0200 Subject: [PATCH] doc: update with stuff produced by the tool --- README.md | 99 ++++++++++++++++++++++++++----------------------------- 1 file changed, 47 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 726a348..b87e165 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,87 @@ # GOTASK -Tiny project aiming at creating a CLI task tracker in Golang +Tiny project aiming to create a CLI task tracker in Golang ## Purpose 1. Practice Golang 1. Keep track of tasks -## Roadmap -1. ~~Add~~ -2. ~~List all~~ -3. Progress -4. Regress -5. List by - ## Features ### Add tasks ```console -[user@host]$ gotask add "Publish code" +[user@host]$ gotask-cli add "Publish code" New task "Publish code" added to do @ id=4 ``` ### List all tasks ```console -[user@host]$ gotask list -+---------------------------------------------------------------------+ -|id| Description | Status | Created | Updated | -|--|--------------|-------------|------------------|------------------| -| 1| Update doc | todo | 01-03-2026 09:23 | | # Never updated -| 2| Write code | doing | 04-03-2026 10:13 | 05-03-2026 17:45 | # Set in progress at UpdateAt -| 3| Write tests | done | 05-03-2026 11:34 | 01-04-2026 19:43 | # Done at UpdateAt -| 4| Publish code | todo | 01-04-2026 09:13 | | -+---------------------------------------------------------------------+ +[user@host]$ gotask-cli list ++----+--------------+--------+---------------------+---------+ +| ID | DESCRIPTION | STATUS | CREATED | UPDATED | ++----+--------------+--------+---------------------+---------+ +| 1 | Update doc | todo | 2026-04-03 22:34:40 | | +| 2 | Write code | todo | 2026-04-03 22:38:26 | | +| 3 | Write tests | todo | 2026-04-03 22:38:45 | | +| 4 | Publish code | todo | 2026-04-03 22:38:56 | | ++----+--------------+--------+---------------------+---------+ ``` ### Mark progress ```console -[user@host]$ gotask progress 4 +[user@host]$ gotask-cli progress 4 [todo] task "Publish code" progress to [doing] ``` ### List tasks by status ```console -[user@host]$ gotask list doing -+---------------------------------------------------------------------+ -|id| Description | Status | Created | Updated | -|--|--------------|-------------|------------------|------------------| -| 2| Write code | doing | 04-03-2026 10:13 | 05-03-2026 17:45 | -| 4| Publish code | doing | 01-04-2026 09:13 | 01-04-2026 10:30 | -+---------------------------------------------------------------------+ +[user@host]$ gotask-cli list doing ++----+--------------+--------+---------------------+---------------------+ +| ID | DESCRIPTION | STATUS | CREATED | UPDATED | ++----+--------------+--------+---------------------+---------------------+ +| 4 | Publish code | doing | 2026-04-03 22:38:56 | 2026-04-03 22:44:36 | ++----+--------------+--------+---------------------+---------------------+ ``` ### Mark regress ```console -[user@host]$ gotask regress 4 +[user@host]$ gotask-cli regress 4 [doing] task "Publish code" regress to [todo] ``` -### List task by id -```console -[user@host]$ gotask list 4 -+---------------------------------------------------------------------+ -|id| Description | Status | Created | Updated | -|--|--------------|-------------|------------------|------------------| -| 4| Publish code | todo | 01-04-2026 09:13 | 01-04-2026 10:33 | -+---------------------------------------------------------------------+ -``` - - ## Storing data For convenience reasons, the data will be stored in a JSON file with the following structure. ```json [ - { - "id": 1, - "Description": "Update doc", - "Status": 0, - "Created": 1772353380, - "UpdatedAt": -1 - }, - { - "id": 2, - "Description": "Write code", - "Status": 1, - "Created": 1772615580, - "UpdatedAt": 1772729100 - } + { + "Id": 1, + "Description": "Update doc", + "Status": 0, + "Created": 1775248480, + "Updated": -1 + }, + { + "Id": 2, + "Description": "Write code", + "Status": 0, + "Created": 1775248706, + "Updated": -1 + }, + { + "Id": 3, + "Description": "Write tests", + "Status": 0, + "Created": 1775248725, + "Updated": -1 + }, + { + "Id": 4, + "Description": "Publish code", + "Status": 0, + "Created": 1775248736, + "Updated": 1775249113 + } ] ```