joplin-plugin-quick-note 1.1.4 → 1.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,72 +1,72 @@
1
1
  # Quick Note
2
2
 
3
- Quick Note is joplin plugin which allows you to instantly open a dedicated note for capturing ideas, tasks, or reminders — either on startup or via a customizable keyboard shortcut.
4
-
5
- <link rel="icon" type="image/x-icon" href="docs/assets/icon-32.png">
6
-
7
- <div align=center>
8
- <p>Capture ideas instantly with a dedicated Quick Note.</p>
9
- </div>
3
+ Quick Note is a Joplin plugin that lets you instantly open a dedicated note either automatically on startup or anytime via a keyboard shortcut.
10
4
 
11
5
  ## Features
12
6
 
13
- - Open a Quick Note on Joplin startup.
14
- - Set any note as your Quick Note.
15
- - Open Quick Note anytime with **Alt+Q** (customizable shortcut).
16
- - Toolbar button for one-click access.
17
- - Easily unset the Quick Note when no longer needed.
7
+ - 🚀 Automatically open Quick Note on Joplin startup (can be disabled)
8
+ - 📝 Set **any existing note** as your Quick Note
9
+ - ⌨️ Open Quick Note anytime with **Alt + Q** (customizable)
10
+ - 🔄 Easily unset or change the Quick Note
18
11
 
19
12
  ## Installation
20
13
 
21
- There are two ways to install Quick Note:
14
+ 1. **From Market-Place (Recommended)**
22
15
 
23
- ### **Joplin Market Place**
16
+ - Open Joplin and navigate to **Tools → Options → Plugins → Search**
17
+ - Search for **Quick Note**
18
+ - Click **Install** and restart Joplin
24
19
 
25
- - Open Joplin → Tools → Options → Plugins → `Search`.
26
- - Search for **Quick Note** and install directly.
20
+ 2. **From Source**
27
21
 
28
- ### **Build from source**
29
-
30
- - Clone the repositroy:
22
+ - Build the plugin package file (.jpl):
31
23
 
32
24
  ```bash
33
25
  git clone https://github.com/cipherswami/joplin-plugin-quick-note.git
26
+ cd joplin-plugin-quick-note
27
+ npm install
28
+ npm run dist
34
29
  ```
35
30
 
36
- - Install dependencies:
31
+ - Then in Joplin, Go to **Tools → Options → Plugins → Install from file**
32
+ - Select the generated `.jpl` file from the `publish/` directory
37
33
 
38
- ```bash
39
- npm install
40
- ```
34
+ ## Usage
41
35
 
42
- * Generate the plugin package (`.jpl` will be created in the `publish/` directory):
36
+ **Set a Quick Note:**
43
37
 
44
- ```bash
45
- npm run dist
46
- ```
38
+ - Open a note and go to **Tools → Quick Note → Set as Quick Note**, OR
39
+ - Paste the Note ID in **Tools → Options → Quick Note → Quick NoteID**, OR
40
+ - Open desired note and run the **Set as Quick Note** command
47
41
 
48
- * In Joplin, go to **Tools Options → Plugins → Install from file**, then select the generated `.jpl` to install it.
42
+ **Access Quick Note:**
49
43
 
50
- ## Usage
44
+ - Press **Alt + Q** _(customizable shortcut)_, OR
45
+ - Click the **Quick Note** toolbar button, OR
46
+ - Go to **Tools → Quick Note → Open Quick Note**, OR
47
+ - Run the **Open Quick Note** command
51
48
 
52
- 1. Select a note **Tools Quick Note Set as Quick Note**.
53
- 2. Quick Note automatically opens on Joplin startup (can be disabled in settings).
54
- 3. Press **Alt+Q** (or your configured shortcut) to open the Quick Note instantly.
55
- 4. To unset the Quick Note, use **Unset Quick Note** from the menu.
49
+ _Note: Plugin automatically opens quick note on startup (Can be turned off in settings)_
56
50
 
57
- ## Commands
51
+ **Remove Quick Note:**
58
52
 
59
- - **Open Quick Note**Opens your Quick Note.
60
- - **Set as Quick Note** → Sets the current note as your Quick Note.
61
- - **Unset Quick Note** → Removes the Quick Note.
53
+ - Go to **Tools Quick Note → Unset Quick Note**, OR
54
+ - Run the **Unset Quick Note** command
62
55
 
63
56
  ## Settings
64
57
 
65
- Navigate to **Tools → Options → Quick Note** to configure:
58
+ Access settings at **Tools → Options → Quick Note**:
59
+
60
+ - **Open on Startup** - Automatically open Quick Note when Joplin launches
61
+ - **Quick Note ID** - The NoteID of your designated Quick Note
62
+
63
+ ## Support
64
+
65
+ - **Questions & Discussions**: Join the conversation on the [Joplin Forum](https://discourse.joplinapp.org/t/quick-note/47445)
66
+ - **Bug Reports**: Report issues on [GitHub Issues](https://github.com/cipherswami/joplin-plugin-quick-note/issues).
66
67
 
67
- - **Open on Startup**: Automatically open the Quick Note when Joplin starts.
68
- - **Quick Note ID**: The ID of the note set as Quick Note.
68
+ ## License
69
69
 
70
- ## Contributing
70
+ This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
71
71
 
72
- Contributions are welcome! Feel free to open issues or pull requests on [GitHub](https://github.com/cipherswami/joplin-plugin-quick-note).
72
+ Contributions are welcome! Visit the [GitHub repository](https://github.com/cipherswami/joplin-plugin-quick-note) to submit pull requests or suggest new features.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "joplin-plugin-quick-note",
3
- "version": "1.1.4",
3
+ "version": "1.1.6",
4
4
  "scripts": {
5
5
  "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
6
6
  "prepare": "npm run dist",
@@ -2,7 +2,7 @@
2
2
  "manifest_version": 1,
3
3
  "id": "com.cipherswami.quick.note",
4
4
  "app_min_version": "3.3",
5
- "version": "1.1.4",
5
+ "version": "1.1.6",
6
6
  "name": "Quick Note",
7
7
  "description": "Quickly jot down notes on startup or with a shortcut.",
8
8
  "author": "Aravind Potluri",
@@ -48,6 +48,6 @@
48
48
  "512": "docs/assets/icon-512.png"
49
49
  },
50
50
  "promo_tile": {},
51
- "_publish_hash": "sha256:2e2020eca17c165403f19a23c0bbdadeba49cca56a99dbaadf38fde8b2b3695c",
52
- "_publish_commit": "main:1e43bd9fb47926bce2cae68f35776ed6b92055a8"
51
+ "_publish_hash": "sha256:3546da0128736c2ad8e18531e59e99d703dc4ed07389be3a54aa9b8634bfd17b",
52
+ "_publish_commit": "main:13ac91163a67167e5e1aa882b531e705cce0f74a"
53
53
  }