Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kraanzu committed Nov 10, 2024
1 parent 4ac9db7 commit c5e2708
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 48 deletions.
81 changes: 33 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,77 +2,62 @@

# Dooit ✔️
*A todo manager that you didn't ask for, but needed !* \
to make sure that you complete your tasks on time ;)

[![GitHub issues](https://img.shields.io/github/issues/kraanzu/dooit?color=red&style=for-the-badge)](https://github.com/kraanzu/doit/issues)
[![GitHub stars](https://img.shields.io/github/stars/kraanzu/dooit?color=green&style=for-the-badge)](https://github.com/kraanzu/doit/stargazers)
[![GitHub license](https://img.shields.io/github/license/kraanzu/dooit?color=yellow&style=for-the-badge)](https://github.com/kraanzu/doit/blob/main/LICENSE)
[![Support Server](https://img.shields.io/discord/989186205025464390.svg?label=Discord&logo=Discord&colorB=7289da&style=for-the-badge)](https://discord.gg/WA2ER9MBWa)
[![GitHub issues](https://img.shields.io/github/issues/dooit-org/dooit?color=red&style=flat-square)](https://github.com/dooit-org/doit/issues)
[![GitHub stars](https://img.shields.io/github/stars/dooit-org/dooit?color=green&style=flat-square)](https://github.com/dooit-org/doit/stargazers)
[![GitHub license](https://img.shields.io/github/license/dooit-org/dooit?color=yellow&style=flat-square)](https://github.com/dooit-org/doit/blob/main/LICENSE)
[![Support Server](https://img.shields.io/discord/989186205025464390.svg?label=Discord&logo=Discord&colorB=7289da&style=flat-square)](https://discord.gg/WA2ER9MBWa)

# Installation 🔨
-----------------------------

Dooit can be installed with various package managers!
For installation and configuration, check out [the wiki](https://dooit-org.github.io/dooit/)

### With Pip 🐍

> **Note**
Make sure your `python local bin` is in `$PATH`

You can install dooit easily using a python one-liner.

```bash
pip install dooit
```

### With AUR helper 📦
```
yay -S dooit
```
# Features 🌟

### With Homebrew 🍻
- An interactive & beautiful UI
- Fully customizable, you can configure your bar, your colors and how everything is displayed!
- Extensible, python config file allows you to do as much as you like!
- Vim like keybindings
- Topicwise separated Todo Lists (With branching)

You can install the latest stable version of dooit with [Homebrew](https://brew.sh):
**Note: See [CHANGELOG.md](CHANGELOG.md) to get more details on changes and feature additions!**

```bash
brew install dooit
```
# Usage and configuration :gear:
After launching the app, You can press the `?` key to know the keybindings!

Alternatively, you can install the most recent development version of dooit:
# Screenshots 🖼️

```bash
brew install dooit --HEAD
```
Some screenshots of app with different customized configuration <3

# Features 🌟
<details>
<summary>An icy configuration based on NordTheme ❄️ </summary>

![Preview 1](./imgs/config1.png)

> Some features that dooit comes with:
</details>

- An interactive & beautiful UI
- Configurable icons, themes and bar!
- Vim like keybindings
- Topicwise separated Todo Lists (With branching)
- Nested todos!
- Support for recurrence todos
- Sort options with menu (Name, Date, Urgency, Status)
<details>
<summary>A colorful configuration based on Catpuccin 🐱 </summary>

![Preview 2](./imgs/config2.png)

**Note: See [CHANGELOG.md](CHANGELOG.md) to get more details on changes and feature additions!**
</details>

# Usage and configuration :gear:
After launching the app, You can press the `?` key to get started with the app :)\
You can also tweak everything including the UI, keybindings and status bar to your liking\
Head over to [wiki](https://github.com/kraanzu/dooit/wiki/Configuration) to know more!
<details>
<summary>A calm configuration based on Everforest 🌲 </summary>
![Preview 3](./imgs/config3.png)

</details>

# Screenshots 🖼️
![PREVIEW](imgs/preview.png)

# Contribution 🤝
- Want to contribute? Feel free to open a PR! 😸
- Got some ideas for improvements? I'm all ears! 👂
- If you have an idea that related to customizability, open an issue at [Dooit Extras](https://github.com/dooit-org/dooit-extras) instead

----------------------------

#### Other TUI projects 🤓 :
If you liked dooit then you might wanna try out some of my other TUI projects as well
- [smassh](https://github.com/kraanzu/smassh) - A typing-test app for terminal
- [gupshup](https://github.com/kraanzu/gupshup) - A localhost TUI chat client
Binary file added imgs/config1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/config2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/config3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed imgs/shot1.png
Binary file not shown.
Binary file removed imgs/shot2.png
Binary file not shown.
Binary file removed imgs/shot3.png
Binary file not shown.

0 comments on commit c5e2708

Please sign in to comment.