From 557e159a14f38688c9a7f2d199a7a2906383c0a4 Mon Sep 17 00:00:00 2001 From: Saad Saif Date: Mon, 18 Sep 2023 12:37:47 -0400 Subject: [PATCH] update readme --- README.md | 32 +++++++++----------------------- 1 file changed, 9 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 3e51579..72e21ab 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Obsidian Strava Plugin +# Obsidian for Strava Plugin This plugin enables downloading and visualizing Strava activities to the Obsidian vault. @@ -60,39 +60,25 @@ Quick starting guide for new plugin devs: - Reload Obsidian to load the new version of your plugin. Or use the hot reload plugin to load changes as they occur https://github.com/pjeby/hot-reload. - Enable plugin in settings window. -## Releasing new releases +## Releasing - 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. +- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. E.g., + ``` + git tag -a 1.0.0 -m "1.0.0" + git push origin 1.0.0 + ``` +- Github actions will execute upon pushing a new tag and will create a draft release on Github. +- Specify release notes on github and 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. - ## 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\` - - ## Obisdian API Documentation See https://github.com/obsidianmd/obsidian-api