Skip to content

Commit f28108b

Browse files
committed
docs: streamline README with cleaner formatting and concise content
- Remove emojis and excessive formatting for cleaner presentation - Consolidate feature descriptions into a structured table format - Simplify installation instructions with clear numbered steps - Remove screenshot section and detailed feature subsections - Streamline support section while maintaining essential links - Update documentation links to point to main site - Reduce overall length while preserving all key information
1 parent 1bd9517 commit f28108b

1 file changed

Lines changed: 43 additions & 159 deletions

File tree

README.md

Lines changed: 43 additions & 159 deletions
Original file line numberDiff line numberDiff line change
@@ -6,195 +6,79 @@
66
[![Version](https://img.shields.io/badge/version-9.0.0-blue.svg)](https://github.com/Quorafind/Obsidian-Task-Genius)
77
[![Discord](https://img.shields.io/discord/1382008288706695229?color=7289da&label=Discord&logo=discord&logoColor=white)](https://discord.gg/ARR2rHHX6b)
88

9-
Transform your Obsidian vault into a powerful task management system with advanced features, beautiful visualizations, and seamless workflow integration.
10-
11-
[📖 Documentation](https://taskgenius.md/docs/getting-started)[🚀 Installation](https://taskgenius.md/docs/installation)[💬 Community](https://discord.gg/ARR2rHHX6b)
9+
[Documentation](https://taskgenius.md)[Installation](#installation)[Discord Community](https://discord.gg/ARR2rHHX6b)
1210
</div>
1311

1412
---
1513

16-
## 🌟 Overview
17-
18-
Task Genius is a comprehensive task management plugin that transforms Obsidian into a powerful productivity hub. Whether you're managing personal projects, tracking habits, or coordinating complex workflows, Task Genius provides the tools you need while preserving Obsidian's philosophy of plain-text, future-proof note-taking.
19-
20-
### 📸 Screenshots
14+
## Overview
2115

22-
| Forecast View | Inbox Management |
23-
|:-------------:|:----------------:|
24-
| ![Task Genius Forecast](./media/Forecast.png) | ![Task Genius Inbox](./media/Table.png) |
16+
Task Genius transforms Obsidian into a powerful task management system with advanced features, beautiful visualizations, and seamless workflow integration - all while preserving Obsidian's philosophy of plain-text, future-proof note-taking.
2517

2618
---
2719

28-
## ✨ Core Features
29-
30-
### 🎯 **Task Management & Visualization**
31-
32-
#### **Smart Progress Tracking**
33-
- **Visual Progress Bars**: Automatic progress visualization for parent tasks based on sub-task completion
34-
- **Multiple Display Modes**: Choose between graphical bars, text-based indicators, or custom formats
35-
- **Heading Integration**: Progress bars work seamlessly with Markdown headings and list items
36-
- **Real-time Updates**: Progress updates automatically as you complete sub-tasks
37-
38-
#### **Advanced Task Statuses**
39-
- **Extended Status System**: Beyond basic todo/done - includes In Progress `[/]`, Planned `[?]`, Abandoned `[-]`, and more
40-
- **Status Cycling**: Click through task statuses or use keyboard shortcuts for rapid updates
41-
- **Custom Status Definitions**: Define your own task states with custom icons and behaviors
42-
- **Bulk Status Operations**: Update multiple tasks simultaneously
43-
44-
### 📅 **Date & Priority Management**
45-
46-
#### **Intelligent Date Handling**
47-
- **Calendar Picker Integration**: Visual date selection with `📅 2023-12-25` format
48-
- **Multiple Date Types**: Due dates, start dates, scheduled dates, and completion tracking
49-
- **Recurrence Support**: Automatic recurring task generation with flexible patterns
50-
- **Daily Note Integration**: Seamlessly work with your daily notes workflow
51-
52-
#### **Priority System**
53-
- **Visual Priority Indicators**: 🔺 Highest, ⏫ High, 🔼 Medium, 🔽 Low, ⏬ Lowest
54-
- **Alternative Formats**: Support for `[#A]`, `[#B]`, `[#C]` priority notation
55-
- **Context Menu Access**: Right-click to quickly assign priorities
56-
- **Smart Sorting**: Automatic task ordering based on priority levels
57-
58-
### 🔍 **Advanced Filtering & Search**
59-
60-
#### **In-Editor Task Filtering**
61-
- **Dynamic Filtering**: Filter tasks within notes based on status, content, tags, and relationships
62-
- **Relationship Awareness**: Filter by parent/child/sibling task relationships
63-
- **Filter Presets**: Save and reuse common filter combinations
64-
- **Toggle Panel**: Non-intrusive filtering interface that preserves your editing flow
65-
66-
#### **Global Task Search**
67-
- **Vault-wide Discovery**: Find tasks across your entire vault instantly
68-
- **Complex Queries**: Combine multiple criteria for precise task discovery
69-
- **Saved Searches**: Store frequently used search patterns
70-
- **Real-time Results**: Search results update as you type
71-
72-
### 🏗️ **Workflow Management**
73-
74-
#### **Multi-Stage Workflows**
75-
- **Custom Workflow Definition**: Create workflows like Todo → Doing → Review → Done
76-
- **Automatic Timestamping**: Track time spent in each workflow stage
77-
- **Duration Analytics**: Understand your workflow bottlenecks and efficiency
78-
- **Next-Task Creation**: Automatically generate follow-up tasks
79-
80-
#### **Specialized Workflows**
81-
- **Patent Process Management**: Built-in templates for patent workflows
82-
- **Project Management**: Standard project lifecycle templates
83-
- **Custom Templates**: Design workflows specific to your needs
84-
85-
### 📊 **Unified Task Views**
86-
87-
#### **Multiple View Modes**
88-
- **Inbox**: Capture and process new tasks efficiently
89-
- **Forecast**: Timeline view of upcoming tasks and deadlines
90-
- **Projects**: Organize tasks by project with progress tracking
91-
- **Tags**: Group and manage tasks by tag categories
92-
- **Review**: Systematic review of task status and progress
93-
- **Calendar**: Visual calendar interface for date-based task management
94-
- **Gantt Charts**: Project timeline visualization with dependencies
95-
96-
#### **Customizable Perspectives**
97-
- **OmniFocus-Style Views**: Create custom perspectives with advanced filtering
98-
- **Saved Configurations**: Store multiple view configurations for different contexts
99-
- **Flexible Layouts**: Adjust columns, grouping, and sorting to match your workflow
100-
101-
### **Quick Capture & Automation**
102-
103-
#### **Rapid Task Entry**
104-
- **Quick Capture Panel**: Press `Alt+C` for instant task creation
105-
- **Global Commands**: Create tasks from anywhere in Obsidian
106-
- **Template Support**: Use templates for consistent task formatting
107-
- **Metadata Integration**: Automatically add dates, priorities, and tags
108-
109-
#### **Task Automation**
110-
- **Completed Task Archiving**: Automatically move completed tasks to designated files
111-
- **Smart Task Moving**: Bulk operations for task organization
112-
- **Auto-completion**: Parent tasks complete when all sub-tasks are done
113-
- **Status Propagation**: Intelligent status updates through task hierarchies
114-
115-
### 🎮 **Gamification & Habits**
116-
117-
#### **Reward System**
118-
- **Achievement Rewards**: Earn rewards for completing tasks and reaching milestones
119-
- **Customizable Rewards**: Define your own reward types and conditions
120-
- **Inventory Management**: Track reward availability and usage
121-
- **Motivational Feedback**: Visual celebrations for task completion
122-
123-
#### **Habit Tracking**
124-
- **Daily Habit Monitoring**: Track habits through daily note metadata
125-
- **Streak Tracking**: Monitor consecutive completion days
126-
- **Visual Calendar**: See habit completion patterns at a glance
127-
- **Multiple Habit Types**: Support for daily, weekly, and custom frequency habits
128-
- **Progress Analytics**: Understand your habit formation patterns
129-
130-
### 🛠️ **Advanced Configuration**
131-
132-
#### **Extensive Customization**
133-
- **Appearance Settings**: Customize colors, icons, and visual elements
134-
- **Behavior Configuration**: Adjust plugin behavior to match your workflow
135-
- **Keyboard Shortcuts**: Comprehensive hotkey support for all major functions
136-
- **Integration Options**: Configure compatibility with other Obsidian plugins
137-
138-
#### **Data Management**
139-
- **Tasks Plugin Compatibility**: Full compatibility with the popular Tasks plugin
140-
- **Import/Export**: Migrate configurations and data between vaults
141-
- **Backup & Restore**: Protect your task management setup
142-
- **Performance Optimization**: Efficient indexing for large vaults
20+
## Core Features
14321

144-
---
22+
| Feature | Description |
23+
|---------|-------------|
24+
| **Task Management** | Visual progress bars, status cycling, bulk operations, and smart task hierarchies |
25+
| **Date & Priority** | Calendar integration, recurring tasks, multiple date types, and visual priority indicators |
26+
| **View Modes** | Inbox, Forecast, Projects, Tags, Calendar, Gantt charts, Kanban boards |
27+
| **Workflows** | Multi-stage workflows with automatic timestamping, templates, and process tracking |
28+
| **Habit Tracking** | Daily habits, streak tracking, visual calendar, and progress analytics |
29+
| **Quick Capture** | Alt+C hotkey, global commands, templates, and automated task creation |
30+
| **Filtering & Search** | Advanced in-editor filtering, vault-wide search, saved queries, and custom perspectives |
31+
| **Gamification** | Achievement rewards, custom milestones, and motivational feedback |
14532

146-
## 🚀 Getting Started
33+
For detailed feature documentation, visit [taskgenius.md](https://taskgenius.md).
14734

148-
### Installation
35+
---
14936

150-
1. **Community Plugin**: Install directly from Obsidian's Community Plugins
151-
2. **Manual Installation**: Download from [releases](https://github.com/Quorafind/Obsidian-Task-Genius/releases)
152-
3. **Beta Testing**: Join our [Discord](https://discord.gg/ARR2rHHX6b) for early access to new features
37+
## Installation
15338

154-
For detailed installation instructions, visit our [Installation Guide](https://taskgenius.md/docs/installation).
39+
### Community Plugin (Recommended)
40+
1. Open Obsidian Settings
41+
2. Navigate to Community Plugins
42+
3. Search for "Task Genius"
43+
4. Click Install, then Enable
15544

156-
### Quick Setup
45+
### Manual Installation
46+
1. Download the latest release from [GitHub Releases](https://github.com/Quorafind/Obsidian-Task-Genius/releases)
47+
2. Extract files to `.obsidian/plugins/Obsidian-Task-Genius/`
48+
3. Enable the plugin in Obsidian settings
15749

158-
1. **Enable the Plugin**: Activate Task Genius in your plugin settings
159-
2. **Open Task View**: Use the ribbon icon or command palette (`Task Genius: Open Task Genius view`)
160-
3. **Configure Your Workflow**: Customize settings to match your task management style
161-
4. **Start Creating Tasks**: Begin with simple `- [ ]` tasks and explore advanced features
50+
---
16251

163-
### First Steps
52+
## Quick Start
16453

165-
- **Create Your First Task**: Try `- [ ] Learn Task Genius features 📅 2024-01-15 🔺`
166-
- **Explore Views**: Switch between Inbox, Forecast, and Projects views
167-
- **Set Up Quick Capture**: Configure `Alt+C` for rapid task entry
168-
- **Join the Community**: Connect with other users on [Discord](https://discord.gg/ARR2rHHX6b)
54+
1. **Enable Plugin**: Activate Task Genius in your plugin settings
55+
2. **Open Task View**: Click the ribbon icon or use Command Palette
56+
3. **Create First Task**: Type `- [ ] My first task` in any note
57+
4. **Explore Views**: Switch between different view modes to find your preferred workflow
16958

17059
---
17160

172-
## 📚 Documentation & Support
173-
174-
### Resources
61+
## Community & Support
17562

176-
- **📖 [Complete Documentation](https://taskgenius.md/docs/getting-started)**: Comprehensive guides and tutorials
63+
### Discord Community
64+
Join our active community for help, tips, and feature discussions:
65+
**[Task Genius Discord](https://discord.gg/ARR2rHHX6b)**
17766

178-
### Community & Support
179-
180-
- **💬 [Discord Community](https://discord.gg/ARR2rHHX6b)**: Get help, share tips, and connect with other users
181-
- **🐛 [Issue Tracker](https://github.com/Quorafind/Obsidian-Task-Genius/issues)**: Report bugs and request features
182-
- **💡 [Feature Requests](https://github.com/Quorafind/Obsidian-Task-Genius/discussions)**: Suggest new features and improvements
67+
### Resources
68+
- [Complete Documentation](https://taskgenius.md)
69+
- [Issue Tracker](https://github.com/Quorafind/Obsidian-Task-Genius/issues)
70+
- [Feature Requests](https://github.com/Quorafind/Obsidian-Task-Genius/discussions)
18371

18472
---
18573

186-
## 💝 Support the Project
74+
## Support the Project
18775

188-
Task Genius is developed with passion and dedication. If you find it valuable for your productivity workflow, consider supporting its continued development:
76+
Task Genius is developed with passion and dedication. If you find it valuable, consider supporting its continued development:
18977

19078
<div align="center">
19179
<a href="https://www.buymeacoffee.com/boninall" target="_blank">
19280
<img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=☕&slug=boninall&button_colour=6495ED&font_colour=ffffff&font_family=Inter&outline_colour=000000&coffee_colour=FFDD00" alt="Buy Me A Coffee" height="50">
19381
</a>
19482
</div>
19583

196-
Your support helps:
197-
- 🚀 **Accelerate Development**: More time for new features and improvements
198-
- 🐛 **Faster Bug Fixes**: Quicker response to issues and problems
199-
- 📚 **Better Documentation**: Comprehensive guides and tutorials
200-
- 🎯 **Feature Requests**: Priority development of community-requested features
84+
Your support enables faster development, better documentation, and priority feature implementation.

0 commit comments

Comments
 (0)