diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..a9a6222 --- /dev/null +++ b/manifest.json @@ -0,0 +1,10 @@ +{ + "id": "obsidian-webhook-plugin", + "name": "Webhook Plugin", + "version": "0.0.2", + "minAppVersion": "0.9.12", + "description": "Plugin that connects your notes to the internet of things through webhooks!", + "author": "Stephen Solka", + "authorUrl": "https://obsidian-buffer.web.app", + "isDesktopOnly": false +} diff --git a/plugin/README.md b/plugin/README.md deleted file mode 100644 index 9e4fe9c..0000000 --- a/plugin/README.md +++ /dev/null @@ -1,57 +0,0 @@ -## Obsidian Sample Plugin - -This is a sample plugin for Obsidian (https://obsidian.md). - -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. - -**Note:** The Obsidian API is still in early alpha and is subject to change at any time! - -This sample plugin demonstrates some of the basic functionality the plugin API can do. -- Changes the default font color to red using `styles.css`. -- 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. - -### First time developing plugins? - -Quick starting guide for new plugin devs: - -- 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. - -### 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. -- Publish the release. - -### Adding your plugin to the community plugin list - -- 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. -- `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/`. - -### API Documentation - -See https://github.com/obsidianmd/obsidian-api diff --git a/plugin/main.ts b/plugin/main.ts index 9635b68..ef6c70b 100644 --- a/plugin/main.ts +++ b/plugin/main.ts @@ -35,7 +35,7 @@ const firebaseConfig = { measurementId: "G-885V9M0N0C", }; -export default class MyPlugin extends Plugin { +export default class ObsidianWebhooksPlugin extends Plugin { settings: MyPluginSettings; firebase: FirebaseApp; loggedIn: boolean; @@ -135,11 +135,11 @@ export default class MyPlugin extends Plugin { } class WebhookSettingTab extends PluginSettingTab { - plugin: MyPlugin; + plugin: ObsidianWebhooksPlugin; auth: Auth; authObserver: Unsubscribe; - constructor(app: App, plugin: MyPlugin) { + constructor(app: App, plugin: ObsidianWebhooksPlugin) { super(app, plugin); this.plugin = plugin; this.auth = getAuth(this.plugin.firebase); diff --git a/plugin/manifest.json b/plugin/manifest.json deleted file mode 100644 index 6f735e9..0000000 --- a/plugin/manifest.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "id": "obsidian-webhook-plugin", - "name": "Webhook Plugin", - "version": "0.0.1", - "minAppVersion": "0.9.12", - "description": "Plugin that connects your notes to the internet of things through webhooks!", - "author": "Stephen Solka", - "authorUrl": "https://obsidian-buffer.web.app", - "isDesktopOnly": false -} diff --git a/plugin/manifest.json b/plugin/manifest.json new file mode 120000 index 0000000..6ea97b4 --- /dev/null +++ b/plugin/manifest.json @@ -0,0 +1 @@ +../manifest.json \ No newline at end of file