diff --git a/README.md b/README.md index bb0348e..c773152 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,8 @@ 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 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. This sample plugin demonstrates some of the basic functionality the plugin API can do. - Adds a ribbon icon, which shows a Notice when clicked. @@ -41,7 +39,7 @@ Quick starting guide for new plugin devs: ## Adding your plugin to the community plugin list -- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md +- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines). - 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. diff --git a/esbuild.config.mjs b/esbuild.config.mjs index b13282b..a5de8b8 100644 --- a/esbuild.config.mjs +++ b/esbuild.config.mjs @@ -38,6 +38,7 @@ const context = await esbuild.context({ sourcemap: prod ? false : "inline", treeShaking: true, outfile: "main.js", + minify: prod, }); if (prod) { @@ -45,4 +46,4 @@ if (prod) { process.exit(0); } else { await context.watch(); -} \ No newline at end of file +} diff --git a/manifest.json b/manifest.json index 624001a..dfa940e 100644 --- a/manifest.json +++ b/manifest.json @@ -3,7 +3,7 @@ "name": "Sample Plugin", "version": "1.0.0", "minAppVersion": "0.15.0", - "description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.", + "description": "Demonstrates some of the capabilities of the Obsidian API.", "author": "Obsidian", "authorUrl": "https://obsidian.md", "fundingUrl": "https://obsidian.md/pricing", diff --git a/tsconfig.json b/tsconfig.json index 2d6fbdf..c44b729 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -10,7 +10,7 @@ "moduleResolution": "node", "importHelpers": true, "isolatedModules": true, - "strictNullChecks": true, + "strictNullChecks": true, "lib": [ "DOM", "ES5",