Merge pull request HeroBlackInk#43 from amildahl/amildahl-patch-1

Suggested README changes

CHANGELOG.md

@@ -0,0 +1,21 @@
+## CHANGELOG
+### prelease [1.0.38] - 2023-06-09
+
+https://github.com/HeroBlackInk/ultimate-todoist-sync-for-obsidian/releases/tag/v1.0.38-beta
+
+- New feature
+    - 1.0.38 beta now supports date formats for tasks.
+    - Todoist task link is added.
+
+### prelease [1.0.37] - 2023-06-05
+
+https://github.com/HeroBlackInk/ultimate-todoist-sync-for-obsidian/releases/tag/v1.0.37-beta
+
+- New feature
+    - Two-way automatic synchronization, no longer need to manually click the sync button.
+    - Full vault sync option, automatically adding `#todoist` to all tasks.
+    - Notes/comments one-way synchronization from Todoist to Obsidian.
+- Bug fix
+    - Fixed the bug of time zone conversion.
+    - Removed the "#" from the Todoist label.
+    - Update the obsidian link in Todoist after moving or renaming a file.

README.md

@@ -1,33 +1,6 @@
 # Ultimate Todoist Sync for Obsidian
 
-It should be the best Obsidian plugin for synchronizing Todoist tasks so far.
-
-
-## CHANGELOG
-### prelease [1.0.38] - 2023-06-09
-
-https://github.com/HeroBlackInk/ultimate-todoist-sync-for-obsidian/releases/tag/v1.0.38-beta
-
-- New feature
-    - 1.0.38 beta now supports date formats for tasks.
-    - Todoist task link is added.
-
-
-
-## CHANGELOG
-### prelease [1.0.37] - 2023-06-05
-
-https://github.com/HeroBlackInk/ultimate-todoist-sync-for-obsidian/releases/tag/v1.0.37-beta
-
-- New feature
-    - Two-way automatic synchronization, no longer need to manually click the sync button.
-    - Full vault sync option, automatically adding `#todoist` to all tasks.
-    - Notes/comments one-way synchronization from Todoist to Obsidian.
-- Bug fix
-    - Fixed the bug of time zone conversion.
-    - Removed the "#" from the Todoist label.
-    - Update the obsidian link in Todoist after moving or renaming a file.
-
+The Ultimate Todoist Sync plugin automatically creates tasks in Todoist and synchronizes task state between Obsidian and Todoist.
 
 
 ## Demo
@@ -39,11 +12,10 @@ https://github.com/HeroBlackInk/ultimate-todoist-sync-for-obsidian/releases/tag/
 <img src="/attachment/settings.png" width="500">
 
 
-
 ## Features 
 
 ### 
-|                         | Sync from Obsidian to Todoist | Sync from Todoist to Obsidian | Description |
+| Feature                 | Sync from Obsidian to Todoist | Sync from Todoist to Obsidian | Description |
 |-------------------------|-------------------------------|-------------------------------|-------------|
 | Add task                | ✅                            | 🔜                           |             |
 | Delete task             | ✅                            | 🔜                           |             |
@@ -63,20 +35,38 @@ https://github.com/HeroBlackInk/ultimate-todoist-sync-for-obsidian/releases/tag/
 | Task notes              | 🔜                            | ✅                           |   Currently, task notes/comments only support one-way synchronization from Todoist to Obsidian.          |
 
 
+## Installation
 
+### From within Obsidian
 
+From Obsidian v1.3.5+, you can activate this plugin within Obsidian by doing the following:
 
+1. Open Obsidian's `Settings` window
+2. Select the `Community plugins` tab on the left
+3. Make sure `Restricted mode` is **off**
+4. Click `Browse` next to `Community Plugins`
+5. Search for and click on `Ultimate Todoist Sync`
+6. Click `Install`
+7. Once installed, close the `Community Plugins` window
+8. Under `Installed Plugins`, activate the `Ultimate Todoist Sync` plugin
 
-## Installation
+You can update the plugin following the same procedure, clicking `Update` instead of `Install`
+
+### Manually
+
+If you would rather install the plugin manually, you can do the following:
 
 1. Download the latest release of the plugin from the [Releases](https://github.com/HeroBlackInk/ultimate-todoist-sync-for-obsidian/releases) page.
 2. Extract the downloaded zip file and copy the entire folder to your Obsidian plugins directory.
 3. Enable the plugin in the Obsidian settings.
 
+
 ## Configuration
 
-1. In the Obsidian settings, click on the "Plugins" tab and then click the gear icon next to the "Ultimate Todoist Sync for Obsidian" plugin.
-2. Enter the Todoist API..
+1. Open Obsidian's `Settings` window
+2. Select the `Community plugins` tab on the left
+3. Under `Installed plugins`, click the gear icon next to the `Ultimate Todoist Sync` plugin
+4. Enter your Todoist API token
 
 
 ## Settings
@@ -87,12 +77,11 @@ New tasks will be added to the default project, and you can change the default p
 3. Full vault sync
 By enabling this option, the plugin will automatically add `#todoist` to all tasks, which will modify all files in the vault.
 
-## Usage
 
+## Usage
 
 ### Task format
 
-
 | Syntax | Description | Example |
 | --- | --- | --- |
 |#todoist|Tasks marked with `#todoist` will be added to Todoist, while tasks without the `#todoist` tag will not be processed.If you have enabled Full vault sync in the settings, `#todoist` will be added automatically.| `- [ ] task #todoist`|
@@ -112,7 +101,6 @@ You can see the current file's default project in the status bar at the bottom r
 <img src="/attachment/statusBar.png" width="500">
 
 
-
 ## Disclaimer
 
 This plugin is for learning purposes only. The author makes no representations or warranties of any kind, express or implied, about the accuracy, completeness, or usefulness of this plugin and shall not be liable for any losses or damages resulting from the use of this plugin.
@@ -121,9 +109,11 @@ The author shall not be responsible for any loss or damage, including but not li
 
 By using this plugin, you agree to be bound by all the terms of this disclaimer. If you have any questions, please contact the author.
 
+
 ## Contributing
 
-Contributions are welcome! If you'd like to contribute to the plugin, please read our [contributing guidelines](CONTRIBUTING.md) and submit a pull request.
+Contributions are welcome! If you'd like to contribute to the plugin, please feel free to submit a pull request.
+
 
 ## License