mirror of
https://github.com/devonthesofa/obsidian-note-status.git
synced 2026-07-22 12:30:24 +00:00
chore: readme
This commit is contained in:
parent
0e7d447f00
commit
6f1ba1da31
1 changed files with 23 additions and 2 deletions
25
README.md
25
README.md
|
|
@ -17,12 +17,11 @@ Enhance your Obsidian workflow with a powerful status tracking system for your n
|
|||
- **Custom Statuses**: Create your own statuses with icons and colors
|
||||
- **Status Templates**: Choose from predefined templates or create your own
|
||||
- **Highly Customizable**: Configure where and how statuses appear
|
||||
- **Large Vault Support**: Optimized for performance with pagination and filtering options
|
||||
|
||||
## Installation
|
||||
> Coming soon to the Obsidian Community Plugins marketplace!
|
||||
|
||||
### Marketplace Installation (Recommended)
|
||||
Once available in the marketplace:
|
||||
1. Open Obsidian → Settings → Community plugins
|
||||
2. Disable Safe mode
|
||||
3. Click "Browse" and search for "Note Status"
|
||||
|
|
@ -99,6 +98,7 @@ To add additional statuses:
|
|||
3. Click on an active status to remove it
|
||||
|
||||
#### Batch Updates
|
||||
|
||||
To update multiple files at once:
|
||||
1. Select multiple files in the file explorer (using Ctrl/Cmd or Shift)
|
||||
2. Right-click and choose "Change status"
|
||||
|
|
@ -107,6 +107,13 @@ To update multiple files at once:
|
|||
|
||||

|
||||
|
||||
#### Large Vault Performance
|
||||
If you have a large vault with thousands of notes, use these features for better performance:
|
||||
|
||||
1. Enable "Exclude unassigned notes from status pane" in settings
|
||||
2. Use the search function to filter notes
|
||||
3. Use pagination controls to navigate through large status groups
|
||||
|
||||
## Configuration
|
||||
### Status Management
|
||||
Access plugin settings via Settings → Note Status
|
||||
|
|
@ -137,6 +144,7 @@ Configure how statuses are displayed:
|
|||
- Auto-hide status bar when status is unknown
|
||||
- Show/hide status icons in file explorer
|
||||
- Hide unknown status in file explorer
|
||||
- **Exclude unassigned notes from status pane** (recommended for large vaults)
|
||||
- Toggle compact view in status pane
|
||||
- Enable/disable multiple statuses mode
|
||||
- Customize frontmatter tag name
|
||||
|
|
@ -165,6 +173,14 @@ obsidian-note-status: ["active", "inProgress"]
|
|||
```
|
||||
The frontmatter tag name can be customized in settings.
|
||||
|
||||
## Performance Recommendations
|
||||
If you have a large vault (1000+ notes), consider these settings for optimal performance:
|
||||
|
||||
1. Enable "Exclude unassigned notes from status pane"
|
||||
2. Enable "Hide unknown status in file explorer"
|
||||
3. Use specific searches rather than browsing all notes
|
||||
4. Consider using "Compact view" in the status pane
|
||||
|
||||
## Development
|
||||
### Project Structure
|
||||
The plugin has been recently restructured with a modern, modular architecture:
|
||||
|
|
@ -251,3 +267,8 @@ The following features and improvements are planned for upcoming releases:
|
|||
- **Canvas integration**: Show status on canvas cards
|
||||
- **Graph view integration**: Visualize notes by status in graph view
|
||||
- **Mobile optimization**: Improved experience on mobile devices
|
||||
|
||||
## Support the Development
|
||||
If you find this plugin useful and would like to support its development, you can make a donation through my PayPal account. Any contribution is greatly appreciated and helps me continue improving the plugin!
|
||||
|
||||
PayPal: https://paypal.me/aleixsoler
|
||||
Loading…
Reference in a new issue