Merge pull request #1 from mark-when/post-beta

Post beta clean-up

Author: Acylation

CONTRIBUTING.md

@@ -1,18 +1,41 @@
-# Obsidian Markwhen
+# Markwhen Obsidian Plugin
 
-![](./screenshot.png)
+![markwhen-obsidian-plugin](./screenshot.png)
 
 ![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?logo=obsidian&color=%23483699&label=downloads&query=%24%5B%22markwhen%22%5D.downloads&url=https%3A%2F%2Fraw.githubusercontent.com%2Fobsidianmd%2Fobsidian-releases%2Fmaster%2Fcommunity-plugin-stats.json)
 
 This plugin integrates [Markwhen](https://github.com/mark-when/markwhen/) into [Obsidian.md](https://obsidian.md/). You can use markwhen syntax to create timelines.
 
-> **Note**  
-> Latest release: NaN  
-> Document version: developer
+> [!Note]  
+> Latest release: 0.0.1  
+> Document version: 0.0.1
+
+## Installation
+
+> [!Note]  
+> Make sure that you are not in the **Restricted Mode**.
+
+### Install the plugin manually
+
+1. Go to the repo's latest [release page](https://github.com/mark-when/obsidian-plugin/releases/latest), and download `main.js`, `manifest.json` and `styles.css` (or the zip file).
+2. Copy these files to your local path `[your vault]/.obsidian/plugins/markwhen/`.
+3. Relaunch Obsidian, or refresh the plugin list, you will see this plugin.
+4. In the plugin list, enable `Markwhen` and enjoy!
+
+### Install via BRAT
+
+:construction:
 
 ## Development
 
-Ensure you first have Obsidian installed. If the path to your vault is something other than `~/Documents/Obsidian Vault`, update `copyAssets.sh` to point to your vault's location.
+Ensure you first have Obsidian installed, and set up a development vault.
+
+For developers on Linux / MacOS, if the path to your vault is something other than `~/Documents/Obsidian Vault`, update `copyAssets.sh` to point to your vault's location.
+
+For developers on Windows, since there's no watch command out-of-the-box, you can place the repo right in the dev vault config directory (i.e. `[your vault]/.obsidian/plugins/markwhen/`), and set the `outDir` to `./` in `vite.config.ts` (vite complains about this).
+
+> [!Note]
+> The plugin id in the manifest is `markwhen`, indicating users will find their plugin under the `.obsidian/plugins/markwhen` directory if they install this plugin from official Obsidian distribution.
 
 ```sh
 git clone [email protected]:mark-when/obsidian-plugin.git
@@ -21,20 +44,4 @@ npm i
 npm run vite
 ```
 
-## Installation
-
-> **Note**  
-> Make sure that you are not in the **Restricted Mode**.
-
-The plugin is in active deveplopment.
-
-### Install the plugin manually
-
-1. Go to the repo's latest [release page](https://github.com/mark-when/obsidian-plugin/releases/latest), and download `obsidian-markwhen.zip`.
-2. Copy these files to your local path `[yourvault]/.obsidian/plugins/`.
-3. Launch/restart Obsidian, or refresh the plugin list, you will see this plugin.
-4. In the plugin list, enable `Markwhen` and enjoy!
-
-### Building the plugin from source code
-
-Check our [contributing instructions](CONTRIBUTING.md).
+You can download and enable the [Hot-Reload](https://github.com/pjeby/hot-reload) plugin in the dev vault to experience a smooth debugging workflow. Every time `main.js`, `manifest.json` or `styles.css` updates, it will trigger an auto-reload.

README.md

@@ -1,5 +1,6 @@
 #!/bin/bash
 
-cp ./out/* ~/Documents/Obsidian\ Vault/.obsidian/plugins/obsidian-markwhen
-cp ./assets/* ~/Documents/Obsidian\ Vault/.obsidian/plugins/obsidian-markwhen/assets
-cp ./styles.css ~/Documents/Obsidian\ Vault/.obsidian/plugins/obsidian-markwhen
+cp ./out/* ~/Documents/Obsidian\ Vault/.obsidian/plugins/markwhen
+cp ./assets/* ~/Documents/Obsidian\ Vault/.obsidian/plugins/markwhen/assets
+cp ./styles.css ~/Documents/Obsidian\ Vault/.obsidian/plugins/markwhen
+cp ./manifest.json ~/Documents/Obsidian\ Vault/.obsidian/plugins/markwhen