README improvements
This commit is contained in:
24
README.md
24
README.md
@@ -4,9 +4,9 @@ Query the RuneScape Wiki directly from Claude Code. Look up items, quests, skill
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Add the marketplace:
|
1. Inside Claude Code, add the marketplace:
|
||||||
```
|
```
|
||||||
plugin marketplace add https://git.samlab.cloud/sam/claude-plugin-runescape.git
|
/plugin marketplace add https://git.samlab.cloud/sam/claude-plugin-runescape.git
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install the plugin:
|
2. Install the plugin:
|
||||||
@@ -27,9 +27,11 @@ Once installed, Claude can use the RuneScape Wiki tools when you ask questions l
|
|||||||
- *"Show me a mining training guide for levels 50–70."*
|
- *"Show me a mining training guide for levels 50–70."*
|
||||||
- *"I'm an ironman — how do I get dragon bones?"*
|
- *"I'm an ironman — how do I get dragon bones?"*
|
||||||
|
|
||||||
## Commands
|
## How It Works
|
||||||
|
|
||||||
All commands take the game (`osrs` or `rs3`) as the first argument.
|
This skill contains a CLI that gives Claude the ability to search the RS wikis & GE prices.
|
||||||
|
|
||||||
|
Claude can then use the below commands to answer your questions:
|
||||||
|
|
||||||
### `item <name>`
|
### `item <name>`
|
||||||
Look up an item's stats, equipment bonuses, drop sources, and Grand Exchange price.
|
Look up an item's stats, equipment bonuses, drop sources, and Grand Exchange price.
|
||||||
@@ -62,17 +64,3 @@ Get live Grand Exchange prices including instant buy/sell, buy limit, and recent
|
|||||||
rsw osrs price "abyssal whip"
|
rsw osrs price "abyssal whip"
|
||||||
rsw rs3 price "blue partyhat"
|
rsw rs3 price "blue partyhat"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Flags
|
|
||||||
|
|
||||||
| Flag | Description |
|
|
||||||
|------|-------------|
|
|
||||||
| `--ironman` / `-i` | Ironman mode: hides GE prices, emphasizes drops, shops, and self-sufficient methods |
|
|
||||||
| `--raw` | Output raw wikitext instead of rendered markdown |
|
|
||||||
|
|
||||||
## Supported games
|
|
||||||
|
|
||||||
| Argument | Wiki |
|
|
||||||
|----------|------|
|
|
||||||
| `osrs` | [oldschool.runescape.wiki](https://oldschool.runescape.wiki) |
|
|
||||||
| `rs3` | [runescape.wiki](https://runescape.wiki) |
|
|
||||||
|
|||||||
Reference in New Issue
Block a user