commit 26d068d237d3deefb649a1d4de8ef1ed6b652954
parent 08add6702a1cf9675516033cc3f593b241519a9f
Author: lishid <lishid@gmail.com>
Date: Wed, 28 Oct 2020 21:12:21 -0400
Update readme.
Diffstat:
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -10,13 +10,14 @@ The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definiti
### Releasing new releases
- Update your `manifest.json` with your new version number, such as `1.0.1`.
-- Create new GitHub release. Use your version number as the "Tag version". Use the exact version number, don't include the prefix `v`.
+- 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.
- Publish the release.
### Adding your plugin to the community plugin list
- 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
