first version of the plugin

README.md

@@ -1,63 +1,44 @@
-# Obsidian Sample Plugin
+# Obsidian Min Width Plugin
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+## What This Plugin Does?
 
-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.
+The Min Width plugin sets the minimum width for the active pane. Obsidian will auto resize the active pane to ensure it is wider enough and shrink other panes accordingly.
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+This plugin is based on the blog post [_Set the Minimum Width of the Active Pane in Obsidian_](https://blog.iany.me/2022/09/set-the-minimum-width-of-the-active-pane-in-obsidian/).
 
-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.
+[![](https://videoapi-muybridge.vimeocdn.com/animated-thumbnails/image/5569408d-3300-4b5c-b4b8-6e8baa5ad413.gif?ClientID=vimeo-core-prod&Date=1663953976&Signature=3840517f68f618fa3b48788f5cc5c1579d95b46b)](https://vimeo.com/752964835)
 
-## First time developing plugins?
+## How to Use
 
-Quick starting guide for new plugin devs:
+### Manually installing the plugin
 
-- 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.
+- Copy over `main.js`, `manifest.json` in the release to your vault `VaultFolder/.obsidian/plugins/obsidian-min-width/`.
 
-## Releasing new releases
+## Contribute
+
+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!
+
+### 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.
+- Upload the files `manifest.json`, `main.js` 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.
 
 > 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`
 
-## Adding your plugin to the community plugin list
-
-- 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
 
-## How to use
-
-- Clone this repo.
+- Clone this repo into your vault as `VaultFolder/.obsidian/plugins/obsidian-min-width`.
 - `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)
+### 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`
@@ -68,6 +49,6 @@ Quick starting guide for new plugin devs:
   - `eslint .\src\`
 
 
-## API Documentation
+### API Documentation
 
 See https://github.com/obsidianmd/obsidian-api