Skip to content

Commit

Permalink
Add publishing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
johansatge committed Jan 3, 2024
1 parent 5606e0b commit 16566ad
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@

- [Installation](#installation)
- [Usage](#usage)
- [Publish a new version](#publish-a-new-version)
- [Changelog](#changelog)
- [License](#license)

## Installation

Expand Down Expand Up @@ -49,6 +52,18 @@ The following options are available:
| `includeLinks` | `true` | Make headings clickable |
| `debugInConsole` | `false` | Print debug info in Obsidian console |

## Publish a new version

- Push a commit with the new version number as message with:
- The relevant changelog in `README.md`
- The new version number in `manifest.json`
- Tag the commit with the version number
- Publish a [new GitHub release](https://github.com/johansatge/obsidian-automatic-table-of-contents/releases/new) with:
- The version number as title
- The changelog from `README.md` as description
- `main.js` and `manifest.json` as attachments
- _Set as the latest release_ checked

## Changelog

This project uses [semver](http://semver.org/).
Expand Down

0 comments on commit 16566ad

Please # to comment.