docs: rewrite install section for v0.1.0 release
Full install instructions with clone URLs for all three remotes, install.sh walkthrough, update/uninstall notes.
This commit is contained in:
parent
e9b04070f3
commit
804d1f3887
1 changed files with 48 additions and 20 deletions
68
README.md
68
README.md
|
|
@ -15,24 +15,60 @@ Buddymon are discovered, caught, and leveled up through real development work
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- [Claude Code](https://claude.ai/code) CLI
|
||||||
|
- Python 3 (already required by Claude Code)
|
||||||
|
- bash
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
|
Clone the repo anywhere and run the install script:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# From the Claude Code marketplace (once listed):
|
git clone https://git.opensourcesolarpunk.com/Circuit-Forge/buddymon.git
|
||||||
/install buddymon
|
cd buddymon
|
||||||
|
bash install.sh
|
||||||
# Or manually — clone and add to your project's .claude/settings.json:
|
|
||||||
git clone https://git.opensourcesolarpunk.com/Circuit-Forge/buddymon.git ~/.claude/plugins/local/buddymon
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Then add to `~/.claude/settings.json`:
|
Then **restart Claude Code** and run:
|
||||||
```json
|
|
||||||
{
|
|
||||||
"enabledPlugins": {
|
|
||||||
"buddymon@local": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
/buddymon start
|
||||||
|
```
|
||||||
|
|
||||||
|
The install script:
|
||||||
|
- Symlinks the repo into `~/.claude/plugins/cache/local/buddymon/0.1.0/`
|
||||||
|
- Registers the plugin in `~/.claude/plugins/installed_plugins.json`
|
||||||
|
- Enables it in `~/.claude/settings.json`
|
||||||
|
- Creates `~/.claude/buddymon/` state directory with initial JSON files
|
||||||
|
|
||||||
|
Because it uses a symlink, any `git pull` in the repo is immediately live — no reinstall needed.
|
||||||
|
|
||||||
|
### Mirrors
|
||||||
|
|
||||||
|
You can clone from any of the three remotes:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Forgejo (primary)
|
||||||
|
git clone https://git.opensourcesolarpunk.com/Circuit-Forge/buddymon.git
|
||||||
|
|
||||||
|
# GitHub
|
||||||
|
git clone https://github.com/CircuitForgeLLC/buddymon.git
|
||||||
|
|
||||||
|
# Codeberg
|
||||||
|
git clone https://codeberg.org/CircuitForge/buddymon.git
|
||||||
|
```
|
||||||
|
|
||||||
|
### Uninstall
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bash install.sh --uninstall
|
||||||
|
```
|
||||||
|
|
||||||
|
Removes the symlink, deregisters from `installed_plugins.json`, and removes the `enabledPlugins` entry. Your `~/.claude/buddymon/` state (roster, XP, encounters) is left intact.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -98,12 +134,4 @@ All state lives in `~/.claude/buddymon/` — never in the repo.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Mirrors
|
|
||||||
|
|
||||||
- **Primary:** https://git.opensourcesolarpunk.com/Circuit-Forge/buddymon
|
|
||||||
- **GitHub:** https://github.com/CircuitForgeLLC/buddymon
|
|
||||||
- **Codeberg:** https://codeberg.org/CircuitForge/buddymon
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
*A [CircuitForge LLC](https://circuitforge.tech) project. MIT license.*
|
*A [CircuitForge LLC](https://circuitforge.tech) project. MIT license.*
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue