From 0c3a4946e6818db145d2ed8288f2b3e6a2eecbdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?O=CC=81scar=20M=2E=20Lage?= Date: Sat, 13 Nov 2021 19:57:07 +0100 Subject: [PATCH] Add: NOTES.md is now README.md --- src/NOTES.md | 17 ----------------- src/README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 17 deletions(-) delete mode 100644 src/NOTES.md create mode 100644 src/README.md diff --git a/src/NOTES.md b/src/NOTES.md deleted file mode 100644 index 5d1504d..0000000 --- a/src/NOTES.md +++ /dev/null @@ -1,17 +0,0 @@ -# Notes - -```sh -$ comando projects [pr] - - listado de proyectos -$ comando tasks [t] [--project|-pr] - - listado de tareas, agrupadas por proyectos -$ comando start -t 212 - - agrega nuevo stamp de la tarea 212 -$ comando stop -$ comando description "Task description" - - agrega descripción al último stamp -$ comando addtask [project] "Task title" - - agrega una nueva tarea al proyecto -$ comando status [--last] - - lista los stamps running y/o los últimos stamps -``` diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..1618abe --- /dev/null +++ b/src/README.md @@ -0,0 +1,28 @@ +# Gst + +Gst is a cli command that consumes a remote API to achieve different actions about time-stamps + +## What we're looking for + +We're looking for a cli command that acts like this: + +```sh +$ gst projects [pr] + - List of projects +$ gst tasks [t] [--project|-pr] 11 + - List of tasks, if -pr grouped per projects else just last open tasks +$ gst start -t 212 + - Add new stamp to the task 212 +$ gst stop + - Stop the last open stamp +$ gst description "Task description" + - Add description to last stamp +$ gst addtask [--project|-pr] 11 "Task title" + - Add a task to a project +$ gst status [--last] + - List last stamps and status (open, closed...), like a summary +``` + +## Why Rust? + +Because my mind wants to learn something new. Also, why not?