From a343405d76297c61ac0b3344d83478ff8ee9383f Mon Sep 17 00:00:00 2001 From: Ryota Ushio <72342591+RyotaUshio@users.noreply.github.com> Date: Thu, 7 Dec 2023 14:19:12 +0900 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 8e0af83..a5d06b0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,27 @@ This is a modified version of https://github.com/obsidianmd/obsidian-sample-plugin. +## Differences from the original sample plugin + - `*.ts` files are put in the `src` directory - The plugin class definition and settings-related code are separated into `main.ts` and `settings.ts` - Release GitHub action is already there - Don't forget to go to `Settings > Actions > General > Workflow permissions` and turn on `Read and write permissions` + +## Usage + +1. Create a new repository using this template ("Use this template" > "Create a new repository") +2. Clone the created repository +3. Modify at least the `id` & `name` fields in `manifest.json`. +4. Modify `package.json` accordingly. +5. Run `npm i` to install the dependencies +6. Run `npm run dev` or `npm run build` to compile your plugin + +### Releasing your plugin + +1. If you haven't, go to `Settings > Actions > General > Workflow permissions` and turn on `Read and write permissions` +2. Bump the version in `manifest.json` (and `package.json`) and then commit & push the change +3. `git tag -a -m ""` +4. `git push origin `. This triggers the release action. +5. When the action is completed, go to the release page of your repository. You will find a newly created draft release. +6. Release the draft when you're ready.