From 2d66f2d84883e52c0ded3c508de2eeb4ff792447 Mon Sep 17 00:00:00 2001 From: shantanuk7 <115521693+shantanuk7@users.noreply.github.com> Date: Thu, 24 Aug 2023 19:25:01 +0530 Subject: [PATCH] Update README.md --- README.md | 64 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 45 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 676dc91..91fcb69 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,58 @@ -A To Do List web app with the ability to organize list items by importance and urgency (Eisenhower Matrix) -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). -## Getting Started +# Eisenhower Matrix (Urgency Matrix) To do list Web App +A simple To Do List web app with the ability to organize list items by importance and urgency (Eisenhower Matrix) + +This type of categorization is also called Urgency matrix. The use case is very simple. You can sort out or categorize your tasks in four different categories: Urgent & Important, Not Urgent but Important, Urgent but not important and lastly, Not Important & Not Urgent. This way, you can priorotize your tasks and can easily decide what to do right now. + +[Live Demo](https://shantanuk7.github.io/todoplus/) + +## Features + +- **Task List**: Add tasks by pressing "Enter", edit by double-clicking. +- **Drag and Drop**: Categorize tasks by dragging them to the appropriate quadrant. +- **Local Storage**: Your tasks stay private, saved in your browser's local storage. + +## How to Use + +1. **Add Tasks**: Press "Enter" to add tasks. Edit by double-clicking. +2. **Categorize**: Drag tasks to the quadrant they fit best: + - **Urgent & Important**: Tasks needing immediate attention. + - **Important, Not Urgent**: Important tasks with no rush. + - **Urgent, Not Important**: Tasks that can be delegated. + - **Neither Urgent nor Important**: Low-priority tasks. -First, run the development server: -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -``` +## Eisenhower Matrix -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +| | Important | Not Important | +|------------------|--------------------|-----------------------| +| Urgent | | | +| Not Urgent | | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +## Installation -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +1. Clone repo and navigate to the directory. +2. Install dependencies: `npm install` +3. Start the server: `npm run dev` +4. Access the app at `http://localhost:3000` -## Learn More +## Contributions + +Contributions are welcome! Feel free to [open an issue](https://github.com/your-username/eisenhower-matrix-app/issues) or submit a pull request. + +## How to decide priority of a task: +The following may come in handy when figuring the urgency and important for a particular task: +- **Do**: Urgent and important tasks. These are the tasks that need to be done immediately and that will have a big impact on your goals. +- **Schedule**: Not urgent but important tasks. These are the tasks that are important, but they can wait. Schedule them for a later time when you have more time. +- **Delegate**: Urgent but not important tasks. These are the tasks that someone else can do for you. Delegate them to free up your time for more important tasks. +- **Delete**: Not urgent and not important tasks. These are the tasks that you don't need to do at all. Delete them from your to-do list to avoid wasting your time. + +This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). + +## Learn More about the technology To learn more about Next.js, take a look at the following resources: - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. -## PocketBase - -This project is currently using PocketBase as the database. You can install it before using it on your local machine. -- [PocketBase Homepage](https://pocketbase.io/)