Add: NOTES.md is now README.md

This commit is contained in:
Óscar M. Lage 2021-11-13 19:57:07 +01:00
parent 14d47b9b93
commit 0c3a4946e6
2 changed files with 28 additions and 17 deletions

View File

@ -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
```

28
src/README.md Normal file
View File

@ -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?