Release v1.0.9: Rename plugin from Focus Task to Immerse
This commit is contained in:
42
README.md
42
README.md
@@ -1,16 +1,16 @@
|
||||
# ⚡ Focus Task
|
||||
# ⚡ Immerse
|
||||
|
||||
A powerful task management and focus timer plugin for [Obsidian](https://obsidian.md), heavily inspired by [Blitzit](https://www.blitzit.app/).
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
## 🎯 Overview
|
||||
|
||||
Focus Task brings the power of time-boxed task management directly into your Obsidian vault. Plan your day, track time with the Pomodoro technique, and crush your tasks with satisfying checkoffs - all without leaving your notes.
|
||||
Immerse brings the power of time-boxed task management directly into your Obsidian vault. Plan your day, track time with the Pomodoro technique, and crush your tasks with satisfying checkoffs - all without leaving your notes.
|
||||
|
||||
### Why Focus Task?
|
||||
### Why Immerse?
|
||||
|
||||
- **Stay in Flow**: No need to switch between apps - manage tasks where you take notes
|
||||
- **Time Awareness**: Know exactly how long tasks take vs. your estimates
|
||||
@@ -60,12 +60,12 @@ Focus Task brings the power of time-boxed task management directly into your Obs
|
||||
### From Obsidian Community Plugins (Coming Soon)
|
||||
1. Open Obsidian Settings
|
||||
2. Go to Community Plugins
|
||||
3. Search for "Focus Task"
|
||||
3. Search for "Immerse"
|
||||
4. Click Install, then Enable
|
||||
|
||||
### Manual Installation
|
||||
1. Download the latest release from the [releases page](https://git.cribdev.com/crib/focus-task/releases)
|
||||
2. Extract the files to your vault's `.obsidian/plugins/focus-task/` folder
|
||||
1. Download the latest release from the [releases page](https://git.cribdev.com/crib/immerse/releases)
|
||||
2. Extract the files to your vault's `.obsidian/plugins/immerse/` folder
|
||||
3. **⚠️ IMPORTANT**: When updating, do NOT replace or delete the existing `data.json` file - this contains all your tasks, settings, and progress!
|
||||
4. Reload Obsidian
|
||||
5. Enable the plugin in Settings → Community Plugins
|
||||
@@ -75,8 +75,8 @@ Focus Task brings the power of time-boxed task management directly into your Obs
|
||||
### Building from Source
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://git.cribdev.com/crib/focus-task.git
|
||||
cd focus-task
|
||||
git clone https://git.cribdev.com/crib/immerse.git
|
||||
cd immerse
|
||||
|
||||
# Install dependencies
|
||||
npm install
|
||||
@@ -85,14 +85,14 @@ npm install
|
||||
npm run build
|
||||
|
||||
# Copy to your vault
|
||||
cp main.js manifest.json styles.css /path/to/your/vault/.obsidian/plugins/focus-task/
|
||||
cp main.js manifest.json styles.css /path/to/your/vault/.obsidian/plugins/immerse/
|
||||
```
|
||||
|
||||
## 📖 Usage
|
||||
|
||||
### Getting Started
|
||||
|
||||
1. **Open Focus Task**: Click the ⚡ icon in the ribbon or use the command palette (`Ctrl/Cmd + P` → "Open Focus Task Panel")
|
||||
1. **Open Immerse**: Click the ⚡ icon in the ribbon or use the command palette (`Ctrl/Cmd + P` → "Open Immerse Panel")
|
||||
|
||||
2. **Add a Task**: Click "+ Add Task" and fill in:
|
||||
- Task description
|
||||
@@ -107,7 +107,7 @@ cp main.js manifest.json styles.css /path/to/your/vault/.obsidian/plugins/focus-
|
||||
|
||||
| Action | Command |
|
||||
|--------|---------|
|
||||
| Open Panel | `Ctrl/Cmd + P` → "Open Focus Task Panel" |
|
||||
| Open Panel | `Ctrl/Cmd + P` → "Open Immerse Panel" |
|
||||
| Quick Add Task | `Ctrl/Cmd + P` → "Quick Add Task" |
|
||||
| Toggle Timer | `Ctrl/Cmd + P` → "Toggle Timer" |
|
||||
| Complete Task | `Ctrl/Cmd + P` → "Complete Current Task" |
|
||||
@@ -188,12 +188,12 @@ Default lists: Work 💼, Personal 🏠, Learning 📚
|
||||
4. Click Save
|
||||
|
||||
### Theming
|
||||
Focus Task respects your Obsidian theme and adapts to both light and dark modes automatically.
|
||||
Immerse respects your Obsidian theme and adapts to both light and dark modes automatically.
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
focus-task/
|
||||
immerse/
|
||||
├── src/
|
||||
│ ├── main.ts # Main plugin class
|
||||
│ ├── types.ts # TypeScript interfaces
|
||||
@@ -218,7 +218,7 @@ Blitzit's approach to productivity resonated with me:
|
||||
- Satisfying task completion experience
|
||||
- Progress insights
|
||||
|
||||
I wanted to bring this experience directly into Obsidian, where I already manage my notes and knowledge. Focus Task is my attempt to capture the essence of what makes Blitzit great while leveraging Obsidian's powerful ecosystem.
|
||||
I wanted to bring this experience directly into Obsidian, where I already manage my notes and knowledge. Immerse is my attempt to capture the essence of what makes Blitzit great while leveraging Obsidian's powerful ecosystem.
|
||||
|
||||
**If you're looking for a dedicated productivity app, I highly recommend checking out [Blitzit](https://www.blitzit.app/)!**
|
||||
|
||||
@@ -236,8 +236,8 @@ Contributions are welcome! Feel free to:
|
||||
|
||||
```bash
|
||||
# Clone the repo
|
||||
git clone https://git.cribdev.com/crib/focus-task.git
|
||||
cd focus-task
|
||||
git clone https://git.cribdev.com/crib/immerse.git
|
||||
cd immerse
|
||||
|
||||
# Install dependencies
|
||||
npm install
|
||||
@@ -246,7 +246,7 @@ npm install
|
||||
npm run dev
|
||||
|
||||
# Create symlink to your test vault
|
||||
ln -s $(pwd) /path/to/vault/.obsidian/plugins/focus-task
|
||||
ln -s $(pwd) /path/to/vault/.obsidian/plugins/immerse
|
||||
```
|
||||
|
||||
## 📜 License
|
||||
@@ -255,8 +255,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
|
||||
## 🔗 Links
|
||||
|
||||
- **Repository**: [https://git.cribdev.com/crib/focus-task](https://git.cribdev.com/crib/focus-task)
|
||||
- **Issues**: [https://git.cribdev.com/crib/focus-task/issues](https://git.cribdev.com/crib/focus-task/issues)
|
||||
- **Repository**: [https://git.cribdev.com/crib/immerse](https://git.cribdev.com/crib/immerse)
|
||||
- **Issues**: [https://git.cribdev.com/crib/immerse/issues](https://git.cribdev.com/crib/immerse/issues)
|
||||
- **Inspiration**: [Blitzit App](https://www.blitzit.app/)
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user