Update README.md

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release Obsidian plugin
+
+on:
+    push:
+        tags:
+            - "*"
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Use Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: "18.x"
+
+            - name: Build plugin
+              run: |
+                  npm install
+                  npm run build
+
+            - name: Create release
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: |
+                  tag="${GITHUB_REF#refs/tags/}"
+
+                  gh release create "$tag" \
+                    --title="$tag" \
+                    --draft \
+                    main.js manifest.json styles.css

README.md

@@ -1,74 +1,100 @@
 # FastForwardLink
 
-Fast-forward from multiple links to a single target note.
+Obsidian lets you link notes. Great.
 
- <img src="fastforwardlink.jpeg" alt="Girl in a jacket" width="400">
+But real people don't always use the same terms consistently:
+- abbreviations
+- acronyms
+- nicknames
+- alternate spellings
+- inside jokes
 
-## Introduction
+So you might write:
+- `javascript`
+- `js`
+- `ecmascript`
 
-FastForwardLink helps you write faster, keep your notes interconnected, and reduce navigation friction in your vault. This plugin allows you to set multiple links to open a single target note, effectively creating synonymous links. Use custom link abbreviations to type faster, establish conceptual connections between terms, navigate between notes quicker, and keep your vault organized.
+...while meaning the exact same thing.
 
-For example, when discussing photo editing software, `ps` is often shorthand for `photoshop`. Without FastForwardLink, the link `[[ps]]` would navigate to a note titled `ps`. But with FastForwardLink, the `[[ps]]` link forwards you directly to your target note `photoshop` (or any other specified note).
+By default, Obsidian treats these as separate notes.
 
-Here are some examples of how you might set up FastForwardLink:
+Over time, that creates:
+- duplicate notes
+- fragmented knowledge base
+- inconsistent linking
+- friction while writing naturally
 
--   `ps` > `photoshop`
--   `js` > `javascript`
--   `tay tay` > `taylor swift`
--   `46` > `joe biden`
--   `e=mc2` > `Einstein's special theory of relativity`
--   `favorite film` > `bill and ted's bogus journey`
+FastForwardLink solves this by turning alias notes into lightweight redirects.
 
-### FastForwardLink Plugin Demo
+Write naturally. Land on the right note — fast.
+
+<img src="fastforwardlink.jpeg" alt="FastForwardLink mascot" width="400">
+
+## FastForwardLink Plugin Demo
 
 ![demo](./plugin_demo.gif)
 
-## Version Updates
+FastForwardLink lets multiple note names point to the same canonical note. Write naturally without fragmenting your vault structure:
 
-### Version 1.1
+- `js` → `javascript`
+- `ps` → `photoshop`
 
-Some improvements include:
+## How It Works
 
--   You can now temporarily bypass forwarding with a designated command!
--   Source code refactored and better organized for future conributors.
--   Better robust event and error handling and messaging.
+Suppose you have a note called `javascript`.
+
+Elsewhere in your vault, you naturally write:
+
+```text
+[[js]]
+```
+Normally, Obsidian would create a brand-new js note. But with FastForwardLink:
+- Create a note called `js`
+- Add redirect syntax inside it
+- Opening `js` automatically forwards to `javascript`
+
+Here are some examples of how you might set up FastForwardLink:
+
+- `ps` > `photoshop`
+- `js` > `javascript`
+- `tay tay` > `taylor swift`
+- `e=mc2` > `Einstein's special theory of relativity`
+- `favorite film` > `bill and ted's bogus journey`
 
 ## Features
 
--   **Multiple Links, One Target**: Set multiple links to redirect to a single target note for quick navigation between related topics or abbreviations. Organize synonyms or alternate spellings for easier access.
+- **Multiple Links, One Target**: Set multiple links to redirect to a single target note for quick navigation between related topics or abbreviations. Organize synonyms or alternate spellings for easier access.
 
--   **Quick-Paste Command**: Set target notes on the fly without breaking your writing flow. In the Obsidian command palette, select **Paste redirect syntax onto selection** to quickly create a forwarding link.
+- **Quick-Paste Command**: Set target notes on the fly without breaking your writing flow. In the Obsidian command palette, select **Paste redirect syntax onto selection** to quickly create a forwarding link.
 
--   **Organized Vault**: Streamline vault navigation by unifying concepts, perfect for efficient, clutter-free notes.
+- **Organized Vault**: Streamline vault navigation by unifying concepts, perfect for efficient, clutter-free notes.
 
--   **Easy Management**: Forwarding notes are automatically moved to a designated folder for easy review, management, or removal.
+- **Easy Management**: Forwarding notes are automatically moved to a designated folder for easy review, management, or removal.
 
--   **Flexible Forwarding Options**:
+- **Flexible Forwarding Options**:
+    - Open the target note in the same tab.
+    - Open the target note in a new tab while remaining on the original note.
+    - Open the target note in a new tab and switch to it automatically.
 
-    -   Open the target note in the same tab.
-    -   Open the target note in a new tab while remaining on the original note.
-    -   Open the target note in a new tab and switch to it automatically.
+- **Remove Forwarding Notes in One Click**: Easily delete all redirecting notes with a single click using plugin settings.
 
--   **Remove Forwarding Notes in One Click**: Easily delete all redirecting notes with a single click using plugin settings.
+## Installation
 
-## Installation and Use
+Download the plugin directly from Obsidian's community plugins. Just search for FastForwardLink.
 
-### Manual Installation
-
-To manually install FastForwardLink:
+You can also install manually by doing the following:
 
 1. [Download the following plugin files](https://github.com/IdanLib/ObsidianFastForwardLinkPlugin):
-
     - `data.json`
     - `main.js`
     - `manifest.json`
 
-2. Copy these file to your vault's plugins folder at `{VaultFolder}/.obsidian/plugins/FastForwardLink`.
+2. Copy these files to your vault's plugins folder at `{VaultFolder}/.obsidian/plugins/FastForwardLink`.
 3. In Obsidian, go to **Settings** > **Community Plugins** and enable **FastForwardLink**.
 
 The plugin is now ready for use.
 
-### Create a Fast-Forward Link
+## Create a Fast-Forward Link
 
 To create a fast-forwarding link:
 
@@ -77,17 +103,27 @@ To create a fast-forwarding link:
 
 Clicking the `ps` link in any note now opens the `photoshop` note.
 
-### Quick-Paste Syntax
+## Quick-Paste Syntax
 
 Yup, typing sucks. Fortunately, there's a command to help you quickly paste the redirect syntax into your code:
 
-1. Press `Ctrl + P` to open the Obsisdian command palette.
+1. Press `Ctrl + P` to open the Obsidian command palette.
 2. Search for and select the command **Paste Redirect Syntax onto Selection**.
 
 The command wraps the selected text in the fast-forward syntax.
 
 > [!TIP] > [Add a hotkey](https://help.obsidian.md/User+interface/Hotkeys#Setting+hotkeys) to trigger this command! We recommend `Ctrl + Alt + R` (PC) or `Cmd + Opt + R` (macOS).
 
+## Version Updates
+
+### Version 1.1
+
+Some improvements include:
+
+- You can now temporarily bypass forwarding with a designated command. In Obsidian's command palette, search for "FastForwardLink".
+- Source code refactored and better organized for future contributors.
+- Better robust event and error handling and messaging.
+
 ## Bugs and Contact
 
 Found a bug? Well, we can't have those!
@@ -96,7 +132,7 @@ Please open an issue in the [plugin's GitHub repository](https://github.com/Idan
 
 ### Known Bugs
 
--   When "Open the target note in a new tab" is enabled and the fast-forwarding note has not yet been moved to the `_forwards_` folder, some additional tabs are opened. This is likely due to internal timing issues in the Obsidian-OS interaction.
+- When "Open the target note in a new tab" is enabled and the fast-forwarding note has not yet been moved to the `_forwards_` folder, some additional tabs are opened. This is likely due to internal timing issues in the Obsidian-OS interaction.
 
     When the fast-forwarding note is in the `_forwards` folder, plugin behavior is as expected.
 

manifest.json

@@ -1,10 +1,10 @@
 {
 	"id": "fast-forward-link",
 	"name": "FastForwardLink",
-	"version": "1.1.0",
+	"version": "1.1.2",
 	"minAppVersion": "0.15.0",
 	"description": "Fast-forward multiple links to a single target note. Create custom link shorthands (like `ps` > `photoshop`) to create synonyms, streamline navigation, and keep your vault organized.",
 	"author": "Idan Liberman",
 	"isDesktopOnly": false,
 	"fundingUrl": "https://buymeacoffee.com/idanlib"
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "fast-forward-link",
-	"version": "1.1.0",
+	"version": "1.1.2",
 	"description": "Forward multiple links to a single note with ease.",
 	"main": "main.js",
 	"scripts": {

versions.json

@@ -1,4 +1,6 @@
 {
 	"1.0.0": "0.15.0",
-	"1.1.0": "0.15.0"
-}
+	"1.1.0": "0.15.0",
+	"1.1.1": "0.15.0",
+	"1.1.2": "0.15.0"
+}