Skip to content

Commit 96bd7e3

Browse files
committed
docs(cli): update README & output reference to v0.10.3
Bump CLI docs to v0.10.3 and refresh quick start. README quick-start was simplified (adds login/setup and condenses the flow to intent → discovery → negotiation → review). The CLI output reference was extensively revamped: version bump to v0.10.3, redesigned help layout, updated endpoints/URLs to https, new sections (Negotiations, Contacts, Scrape & Sync), short IDs/keys in lists, improved network/contact displays, updated commands/examples and options. package.json was also updated to reflect the new CLI version.
1 parent 0b9e6b7 commit 96bd7e3

3 files changed

Lines changed: 478 additions & 138 deletions

File tree

README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,21 @@ Index helps you find the right people—and helps the right people find you—ba
1515
The flow below is one complete story—shape a room, invite people, publish what you need, run discovery inside that context, watch broker negotiations, then accept a match.
1616

1717
```bash
18+
# login + setup
1819
index login
1920
index profile
2021

21-
# 1. Create a network scoped to a specific domain
22-
index network create "AI Privacy Research" --prompt "Researchers working on privacy-preserving ML"
22+
# 1. express intent (signals)
23+
index intent create "federated learning collaboration"
2324

24-
# 2. Invite collaborators
25-
index network invite <network-id> alice@example.com
26-
index network invite <network-id> bob@example.com
27-
28-
# 3. Create signals that describe what you are looking for
29-
index intent create "Looking for someone experienced in federated learning"
30-
index intent create "Need a collaborator for differential privacy benchmarks"
31-
32-
# 4. Link your signals to the network so discovery can find them
33-
index intent link <intent-id-1> <network-id>
34-
index intent link <intent-id-2> <network-id>
35-
36-
# 5. Discovery across the network (no fixed counterpart—who fits depends on members and signals)
25+
# 2. discovery = sourcing + negotiations
3726
index opportunity discover "federated learning collaboration"
3827

39-
# 6. Check what the broker agents negotiated
28+
# 3. check what the agents negotiated
4029
index negotiation list --since 1h
4130
index negotiation show <negotiation-id>
4231

43-
# 7. Review the resulting opportunity and accept
32+
# 4. review outcomes (opportunities) and decide
4433
index opportunity list --status pending
4534
index opportunity show <opportunity-id>
4635
index opportunity accept <opportunity-id>

0 commit comments

Comments
 (0)