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

Added priority feature from issues. #2

Merged
merged 18 commits into from
Aug 11, 2024
94 changes: 57 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,107 +3,127 @@
Clido is an awesome CLI to-do list management application that helps you keep track of your projects and tasks efficiently.

## Table of Contents

1. [About The Project](#about-the-project)
- [Built With](#built-with)
- [Built With](#built-with)
2. [Getting Started](#getting-started)
- [Installation](#installation)
- [Building](#building)
- [Installation](#installation)
- [Building](#building)
3. [Usage](#usage)
- [Commands](#commands)
4. [Roadmap](#roadmap)
5. [License](#license)
6. [Acknowledgments](#acknowledgments)
5. [Contributing](#contributing)
6. [License](#license)

## About The Project

Clido is a simple yet powerful CLI tool designed to help you manage your projects and tasks effectively from the terminal. Whether you are a developer, a project manager, or just someone who loves to keep things organized, Clido is the perfect tool for you.
Clido is a simple yet powerful CLI tool designed to help you manage your projects and tasks effectively from the terminal. Whether you're a developer, a project manager, or just someone who loves to keep things organized, Clido is the perfect tool for you.

### Built With

* [Go](https://golang.org/)
* [SQLite](https://www.sqlite.org/index.html)
* [Color](https://github.com/fatih/color) - For colored terminal output
* [Tablewriter](https://github.com/olekukonko/tablewriter) - For table formatting in terminal
- [Go](https://golang.org/)
- [SQLite](https://www.sqlite.org/index.html)
- [Color](https://github.com/fatih/color) - For colored terminal output
- [Tablewriter](https://github.com/olekukonko/tablewriter) - For table formatting in terminal

## Getting Started

To get a local copy up and running follow these simple steps.
To get a local copy up and running, follow these simple steps.

### Installation

1. Grab the official binary from the [releases page](https://github.com/d4r1us-drk/clido/releases) for your operating system and computer architecture. Currently supported operating systems are Windows, Mac and Linux, each both on x86 and ARM.
2. Move the binary anywhere in your PATH.
3. Enjoy.
1. Download the official binary from the [releases page](https://github.com/d4r1us-drk/clido/releases) for your operating system and computer architecture. Currently supported operating systems are Windows, macOS, and Linux, each for both x86 and ARM architectures.
2. Move the binary to a location in your PATH.
3. Enjoy!

### Building

Make sure to have Go and SQLite installed.
Ensure you have Go and SQLite installed.

1. Clone the project:

1. Clone the project
```sh
git clone https://github.com/d4r1us-drk/clido.git
cd clido
```
```sh
git clone https://github.com/d4r1us-drk/clido.git
cd clido
```

2. Compile and run
```sh
go build
./clido help
```
2. Compile and run:

```sh
go build
./clido help
```

## Usage

Clido allows you to manage projects and tasks with various commands. Below are some usage examples.

### Commands

- Create a new project
- Create a new project:

```sh
clido new project -n "New Project" -d "Project Description"
```

- Create a new task
- Create a new task with priority:

```sh
clido new task -n "New Task" -d "Task Description" -D "2024-08-15 23:00" -p "Existing Project"
clido new task -n "New Task" -d "Task Description" -D "2024-08-15 23:00" -p "Existing Project" -pr 1
```

- Edit an existing project
Priority levels: 1 (High), 2 (Medium), 3 (Low), 4 (None)

- Edit an existing project:

```sh
clido edit project 1 -n "Updated Project Name" -d "Updated Description"
```

- List all projects
- Edit a task's priority:

```sh
clido edit task 1 -pr 2
```

- List all projects:

```sh
clido list projects
```

- List tasks by project number
- List tasks by project number:

```sh
clido list tasks -P 1
```

- Remove a project
- Remove a project:

```sh
clido remove project 1
```

- Toggle task completion
- Toggle task completion:

```sh
clido toggle 1
```

For detailed help, use the help command:

```sh
clido help
```

## Roadmap

- [x] Add task and project management
- [ ] Add priority levels for tasks
- [x] Add priority levels for tasks
- [ ] Add sub-tasks and sub-projects
- [ ] Add a config file with customizable options, like database path, date-time format, etc.
- [ ] Add a json output option to facilitate scripting.
- [ ] Add reminders and notifications, (this would require a deamon).
- [ ] Add a JSON output option to facilitate scripting
- [ ] Add reminders and notifications (this would require a daemon)
- [ ] Add a TUI interface

See the [open issues](https://github.com/d4r1us-drk/clido/issues) for a full list of proposed features (and known issues).
Expand All @@ -120,4 +140,4 @@ Contributions are what make the open source community such an amazing place to l

## License

Distributed under the GPLv3 License. See `LICENSE.txt` for more information.
Distributed under the GPLv3 License. See `LICENSE.txt` for more information.
Loading