Release packaging
This commit is contained in:
30
README.md
30
README.md
@@ -23,10 +23,32 @@ _Note: plugin author is not afiliated with OpenCode or Obsidian - this is a 3rd
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone to `.obsidian/plugins/obsidian-opencode` subdirectory under your vault's root
|
||||
2. Run `bun install && bun run build`
|
||||
3. Enable in Obsidian Settings > Community plugins
|
||||
4. Add AGENTS.md to the workspace root, use it to explain the structure
|
||||
### For Users (BRAT - Recommended for Beta Testing)
|
||||
|
||||
The easiest way to install this plugin during beta is via [BRAT](https://github.com/TfTHacker/obsidian42-brat) (Beta Reviewer's Auto-update Tool):
|
||||
|
||||
1. Install the BRAT plugin from Obsidian Community Plugins
|
||||
2. Open BRAT settings and click "Add Beta plugin"
|
||||
3. Enter: `mtymek/opencode-obsidian`
|
||||
4. Click "Add Plugin" - BRAT will install the latest release automatically
|
||||
5. Enable the OpenCode plugin in Obsidian Settings > Community Plugins
|
||||
|
||||
BRAT will automatically check for updates and notify you when new versions are available.
|
||||
|
||||
### For Developers
|
||||
|
||||
If you want to contribute or develop the plugin:
|
||||
|
||||
1. Clone to `.obsidian/plugins/obsidian-opencode` subdirectory under your vault's root:
|
||||
```bash
|
||||
git clone https://github.com/mtymek/opencode-obsidian.git .obsidian/plugins/obsidian-opencode
|
||||
```
|
||||
2. Install dependencies and build:
|
||||
```bash
|
||||
bun install && bun run build
|
||||
```
|
||||
3. Enable in Obsidian Settings > Community Plugins
|
||||
4. Add AGENTS.md to your workspace root to guide the AI assistant
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
Reference in New Issue
Block a user