Skip to content

Commit 94759ef

Browse files
committed
docs: add PyPI install and upgrade guide
- Make pip install hermes-pmxt the primary setup path - Add simple verify, skill install, upgrade, and development sections - Add PyPI project URLs for homepage, repository, and issues
1 parent f855a4f commit 94759ef

3 files changed

Lines changed: 41 additions & 17 deletions

File tree

README.md

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,33 +17,51 @@ Agent: "The market implies a 1.9% chance (No: 98.1%). Polymarket is pricing this
1717

1818
## Installation
1919

20-
Install directly with `pip`, matching the one-command style used by Hermes plugins such
21-
as Mnemosyne. You do not need to clone this repository unless you are developing it.
20+
The PyPI package is live. For most users, this is the whole install:
2221

2322
```bash
24-
pip install "git+https://github.com/0xharryriddle/hermes-pmxt.git"
23+
pip install hermes-pmxt
2524
```
2625

27-
For local development from a checkout:
26+
Verify it works:
2827

2928
```bash
30-
python3 -m venv .venv
31-
source .venv/bin/activate
32-
pip install -e ".[dev]"
29+
python3 -c "from hermes_pmxt import pmxt_runtime_status; print(pmxt_runtime_status())"
3330
```
3431

3532
### Hermes Skill Setup
3633

37-
After installing the package, copy or symlink `skill/SKILL.md` into your Hermes skills
38-
directory so agents know when and how to use the tools. Example:
34+
Install the Hermes skill file so your agent knows when to use the package:
3935

4036
```bash
4137
mkdir -p ~/.hermes/skills/pmxt
42-
cp skill/SKILL.md ~/.hermes/skills/pmxt/SKILL.md
38+
curl -fsSL https://raw.githubusercontent.com/0xharryriddle/hermes-pmxt/main/skill/SKILL.md \
39+
-o ~/.hermes/skills/pmxt/SKILL.md
4340
```
4441

45-
If your Hermes install supports GitHub-backed skill/plugin installation, point it at
46-
`https://github.com/0xharryriddle/hermes-pmxt` and enable the `pmxt` skill.
42+
If your Hermes install supports GitHub-backed skill/plugin installation, use:
43+
44+
```text
45+
https://github.com/0xharryriddle/hermes-pmxt
46+
```
47+
48+
### Upgrade
49+
50+
```bash
51+
pip install --upgrade hermes-pmxt
52+
```
53+
54+
### Development Install
55+
56+
Only clone the repo if you are modifying hermes-pmxt itself:
57+
58+
```bash
59+
git clone https://github.com/0xharryriddle/hermes-pmxt.git
60+
cd hermes-pmxt
61+
python3 -m venv .venv
62+
source .venv/bin/activate
63+
pip install -e ".[dev]"
64+
```
4765

4866
## Modes
4967

pyproject.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ dependencies = [
99
"pmxt>=2.50.0",
1010
]
1111

12+
[project.urls]
13+
Homepage = "https://github.com/0xharryriddle/hermes-pmxt"
14+
Repository = "https://github.com/0xharryriddle/hermes-pmxt"
15+
Issues = "https://github.com/0xharryriddle/hermes-pmxt/issues"
16+
1217
[project.optional-dependencies]
1318
dev = [
1419
"pytest>=8.0",

skill/SKILL.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ arbitrage detection, execution planning, and portfolio inspection.
2626

2727
## Setup
2828

29-
Install the Hermes integration package directly; it brings in `pmxt>=2.50.0`. Do not
30-
instruct users to clone the repo unless they are developing the integration.
29+
Install from PyPI. This brings in `pmxt>=2.50.0`; do not instruct users to clone
30+
the repo unless they are developing the integration.
3131

3232
```bash
33-
pip install "git+https://github.com/0xharryriddle/hermes-pmxt.git"
33+
pip install hermes-pmxt
3434

3535
# Check runtime status
3636
python3 -c "from hermes_pmxt import pmxt_runtime_status; print(pmxt_runtime_status())"
@@ -39,9 +39,10 @@ python3 -c "from hermes_pmxt import pmxt_runtime_status; print(pmxt_runtime_stat
3939
Hosted mode (recommended): set `PMXT_API_KEY` env var. Local sidecar mode works
4040
without an API key but requires pmxt-core running on localhost:3847.
4141

42-
If Hermes needs an explicit skill install, copy this skill file to
42+
If Hermes needs an explicit skill install, install this file to
4343
`~/.hermes/skills/pmxt/SKILL.md` or use your Hermes skill/plugin installer with the
44-
GitHub URL `https://github.com/0xharryriddle/hermes-pmxt`.
44+
GitHub URL `https://github.com/0xharryriddle/hermes-pmxt`. Upgrade with
45+
`pip install --upgrade hermes-pmxt`.
4546

4647
## Quick Reference
4748

0 commit comments

Comments
 (0)