From f6d9ff5751cdfac5695f0912d910d1c8b489d96a Mon Sep 17 00:00:00 2001 From: CxDocForge Admin Date: Tue, 30 Jun 2026 10:48:45 +0000 Subject: [PATCH] Update README.md --- README.md | 169 +++++++++++++++++++++++++++--------------------------- 1 file changed, 84 insertions(+), 85 deletions(-) diff --git a/README.md b/README.md index 87e9355..6d6f504 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,84 @@ -# tdo - - -Tdo is a minimalist hackable to do list suited for handling a wide range of tasks. -We wanted the UI to be as simple as possible, yet allowing deep customization via CSS and Markdown. - -[Open tdo in browser](https://tdoapp.com) - -[Download Windows app](https://github.com/codaxy/tdo/releases) - -Get it for Android by using 'Add to your homescreen' option in Chrome. - - -## Install & Run - -To develop tdo on your computer you'll need [Node.js](https://nodejs.org) installed on your computer. - -Install npm packages: -``` -yarn install -``` -Run: -``` -yarn start -``` -Build: -``` -yarn build -``` -If you don't use yarn yet, npm will do too. - - -## Features - -- task boards -- Markdown support -- search -- custom CSS for boards and lists -- regex based task highlighting -- boolean search -- Google Firebase based authentication and storage -- drag & drop -- keyboard based navigation -- automatic removal of completed items -- touch support -- offline mode - - -

- -

- - - -## Usage - -On the homepage you will be presented with two cards, *Blank page* and *Tutorial*. For the first time it's best you select the tutorial one which will open a preset tutorial board, explaining all the basic functions of Tdo. - -In the upper portion of the page, *Help ?* will provide you with instructions on additional functionality. - - -## Contributing - -We appreciate involvment from the community. -If you wish to contribute, feel free to fork this repository, and create a pull request with your modifications. - - -## FAQ - -- How do I know which element is which in CSS? - - For now you will have to use inspect page, but vwe are planning on additional future implementations. - -- Is there a way i can save my tasks? - - Yes! You can register in the upper part by clicking [Sign in](https://tdoapp.com/signIn). It will also save your CSS code. - - -  -  -  ---- -  -  - -

**Built using CxJS**

- +# tdo + +Tdo is a minimalist hackable to do list suited for handling a wide range of tasks. +We wanted the UI to be as simple as possible, yet allowing deep customization via CSS and Markdown. + +[Open tdo in browser](https://tdoapp.com) + +[Download Windows app](https://github.com/codaxy/tdo/releases) + +Get it for Android by using 'Add to your homescreen' option in Chrome. + +## Install & Run + +To develop tdo on your computer you'll need [Node.js](https://nodejs.org) installed on your computer. + +Install npm packages: + +``` +yarn install +``` + +Run: + +``` +yarn start +``` + +Build: + +``` +yarn build +``` + +If you don't use yarn yet, npm will do too. + +## Features + +- task boards +- Markdown support +- search +- custom CSS for boards and lists +- regex based task highlighting +- boolean search +- Google Firebase based authentication and storage +- drag & drop +- keyboard based navigation +- automatic removal of completed items +- touch support +- offline mode + +![Example](/assets/example-sped_up_2x.gif "Example") +![Original Cropped](/assets/original-cropped.jpg) +![Contrast look](assets/tdo-contrast-card_view-cropped.png) +![Matrix look](/assets/tdo-hacker-cropped.png) +![Light look](/assets/tdo-light-card_view-cropped.png) + +## Usage + +On the homepage you will be presented with two cards, _Blank page_ and _Tutorial_. For the first time it's best you select the tutorial one which will open a preset tutorial board, explaining all the basic functions of Tdo. + +In the upper portion of the page, _Help ?_ will provide you with instructions on additional functionality. + +## Contributing + +We appreciate involvment from the community. +If you wish to contribute, feel free to fork this repository, and create a pull request with your modifications. + +## FAQ + +- How do I know which element is which in CSS? + + - For now you will have to use inspect page, but vwe are planning on additional future implementations. +- Is there a way i can save my tasks? + + - Yes! You can register in the upper part by clicking [Sign in](https://tdoapp.com/signIn). It will also save your CSS code. + +##   +  +  + +  +  + +**\*\*Built using** [**CxJS**](https://cxjs.io)**\*\***