Merge pull request #5 from AndyReifman/update-readme

Updating README and changing plugin name

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Andrew Reifman-Packett]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,96 +1,29 @@
-# Obsidian Sample Plugin
+# LinkMagic Plugin for Obsidian
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+The LinkMagic Plugin for Obsidian is a convenient tool designed to simplify the process of adding links to your notes in Obsidian. With LinkMagic, you can define custom Regex Patterns and automatically insert links as you type, without needing to switch between editing and reading modes.
+# Key Features
 
-This project uses Typescript to provide type checking and documentation.
-The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
+  - Regex Pattern Matching: Define custom Regex Patterns to identify specific text strings in your notes.
+  - Automatic Link Insertion: Once a Regex Pattern is matched, LinkMagic automatically inserts the defined link.
+  - Works in Editing Mode: Unlike some other plugins, LinkMagic works seamlessly within the editing mode, saving you time and enhancing your workflow.
+  - Customizable: Configure your Regex Patterns and corresponding links in the plugin's settings page to tailor it to your needs.
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+Usage
 
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
-- Adds a ribbon icon, which shows a Notice when clicked.
-- Adds a command "Open Sample Modal" which opens a Modal.
-- Adds a plugin setting tab to the settings page.
-- Registers a global click event and output 'click' to the console.
-- Registers a global interval which logs 'setInterval' to the console.
+  1. Installation: Install the LinkMagic Plugin from the Obsidian Community Plugins tab.
+  2. Configuration: Navigate to the plugin settings page to define your Regex Patterns and corresponding links.
+  3. Usage: As you type in the editing mode, LinkMagic will detect the defined patterns and automatically insert the associated links when you press space or enter (tab support will be added in future updates).
 
-## First time developing plugins?
+# Example
 
-Quick starting guide for new plugin devs:
 
-- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
-- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
+![An image showing the settings page for LinkMagic with an example pattern](example.png)
 
-## Releasing new releases
 
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
-- Publish the release.
+# Support and Feedback
 
-> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
-> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
+If you encounter any issues or have suggestions for improving LinkMagic, please feel free to [open an issue](https://github.com/AndyReifman/MagicLink/issues) on GitHub.
 
-## Adding your plugin to the community plugin list
+# License
 
-- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
-
-## How to use
-
-- Clone this repo.
-- Make sure your NodeJS is at least v16 (`node --version`).
-- `npm i` or `yarn` to install dependencies.
-- `npm run dev` to start compilation in watch mode.
-
-## Manually installing the plugin
-
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-## Improve code quality with eslint (optional)
-- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. 
-- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
-- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
-  - `eslint .\src\`
-
-## Funding URL
-
-You can include funding URLs where people who use your plugin can financially support it.
-
-The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
-
-```json
-{
-    "fundingUrl": "https://buymeacoffee.com"
-}
-```
-
-If you have multiple URLs, you can also do:
-
-```json
-{
-    "fundingUrl": {
-        "Buy Me a Coffee": "https://buymeacoffee.com",
-        "GitHub Sponsor": "https://github.com/sponsors",
-        "Patreon": "https://www.patreon.com/"
-    }
-}
-```
-
-## API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+LinkMagic is released under the [MIT License](LICENSE).

main.ts

@@ -6,7 +6,7 @@ type PluginSettings = Record<string, { pattern: string, link: string }>;
 
 const DEFAULT_SETTINGS: PluginSettings = {};
 
-export default class LinkAdderPlugin extends Plugin {
+export default class MagicLinkPlugin extends Plugin {
 	settings: PluginSettings;
 
 	async onload() {
@@ -101,9 +101,9 @@ export default class LinkAdderPlugin extends Plugin {
 
 
 class SettingTab extends PluginSettingTab {
-	plugin: LinkAdderPlugin;
+	plugin: MagicLinkPlugin;
 
-	constructor(app: App, plugin: LinkAdderPlugin) {
+	constructor(app: App, plugin: MagicLinkPlugin) {
 		super(app, plugin);
 		this.plugin = plugin;
 	}
@@ -112,7 +112,7 @@ class SettingTab extends PluginSettingTab {
 		const { containerEl } = this;
 
 		containerEl.empty();
-		containerEl.createEl("h2", { text: "Link Adder Settings" });
+		containerEl.createEl("h2", { text: "LinkMagic Settings" });
 
 		let settingName = ""
 		new Setting(containerEl)

manifest.json

@@ -1,7 +1,7 @@
 {
-	"id": "Auto-Link-Adder",
-	"name": "Automatic Link Adder",
-	"version": "0.2.0",
+	"id": "linkmagic",
+	"name": "LinkMagic",
+	"version": "1.0.0",
 	"minAppVersion": "0.15.0",
 	"description": "Automatically adds links to defined regex.",
 	"author": "Andrew Reifman",