From a0a398752c069882a0c89917d4071bbf92dfc94a Mon Sep 17 00:00:00 2001 From: Markus Moser Date: Thu, 13 Mar 2025 10:51:11 +0100 Subject: [PATCH] Moved dev only documentation --- CONTRIBUTING.md | 10 ++++++++++ README.md | 9 --------- 2 files changed, 10 insertions(+), 9 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b069965 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Releasing +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 + +There is an automatic GitHub release workflow in place that gets triggered on a push of a tag. +To push a tag: + +```bash +git tag 1.0.1 +git push origin 1.0.1 +``` diff --git a/README.md b/README.md index 6c1d8a0..2dbb489 100644 --- a/README.md +++ b/README.md @@ -32,14 +32,5 @@ The plugin is not available on the community page, as its mostly for me personal * to compile the scss you can use sass `npm install -g sass` and `sass styles.scss styles.css` 5. Enable the plugin in your Obsidian in the Settings panel "Community Plugins" -# Releasing -There is an automatic GitHub release workflow in place that gets triggered on a push of a tag. -To push a tag: - -```bash -git tag 1.0.1 -git push origin 1.0.1 -``` - # Credits Huge thanks to [Privacy Glasses](https://github.com/jillalberts/privacy-glasses/tree/master) for the groundwork and being licensed under MIT. Use that plugin if you want a more in depth configuration. I personally didn't need or want that much customization and overhead in my plugin. Also i found the "flickering" when opening any file to be too distracting, so i created a simpler version for myself.