Skip to content

Commit 9e6cf5c

Browse files
authored
2 parents d4b8e0f + 15add97 commit 9e6cf5c

File tree

1 file changed

+100
-25
lines changed

1 file changed

+100
-25
lines changed

README.md

Lines changed: 100 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,116 @@
1-
# Website
21

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
2+
# SPID Protocol Documentation
43

5-
### Installation
4+
<img src="https://raw.githubusercontent.com/SPID-Protocol-project/spidprotocol-docs/main/static/img/spid_icon_dark.png" alt="SPID Protocol Logo" width="180" />
65

7-
```
8-
$ yarn
9-
```
6+
**The Smart Packet Identity Layer (SPID)** is an open protocol that powers AI-native, voice-ready communication through structured metadata and universal identifiers. This repository contains the official documentation for SPID and its core components.
107

11-
### Local Development
8+
---
129

13-
```
14-
$ yarn start
15-
```
10+
## 🚀 What is the SPID Protocol?
1611

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
12+
The SPID Protocol defines a new standard for async, AI-mediated communication using **Smart Packets** — rich, structured messages containing:
1813

19-
### Build
14+
- A short voice message
15+
- A full transcript
16+
- Inferred user intent
17+
- Actionable CTA buttons
18+
- Verified identity and metadata
2019

21-
```
22-
$ yarn build
23-
```
20+
SPID is the identity and resolution layer that links each packet to its origin, purpose, and destination. Think of it as **DNS + Schema.org + Email headers for the AI web** — enabling machines to route, respond, and retrieve context-aware messages without noise or ambiguity.
2421

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
22+
---
2623

27-
### Deployment
24+
## 🧠 Why It Matters
2825

29-
Using SSH:
26+
Traditional communication (email, calls, SMS) is outdated for an AI-driven world. Smart Packets and SPID enable:
3027

31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
28+
-**Voice-first communication** that’s human-friendly and AI-optimized
29+
- 🧩 **Structured data** that powers LLM routing and reasoning
30+
- 🕸️ **Linkable metadata** for seamless discovery and retrieval
31+
- 🔐 **Verified identity and intent**, protecting against spam and impersonation
32+
- 📦 **Portable messages**, ready to be shared, archived, or embedded anywhere
3433

35-
Not using SSH:
34+
---
3635

36+
## 📚 Documentation Contents
37+
38+
This repository is built with [Docusaurus](https://docusaurus.io) and contains:
39+
40+
- `docs/` — Core specs, guides, and implementation details
41+
- `static/` — SPID logo assets and shared resources
42+
- `docusaurus.config.js` — Site configuration and navbar settings
43+
44+
---
45+
46+
## 📦 Get Started
47+
48+
To contribute or run locally:
49+
50+
```bash
51+
# Install dependencies
52+
npm install
53+
54+
# Start local dev server
55+
npm run start
3756
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
4057

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
58+
Visit [http://localhost:3000/spidprotocol-docs](http://localhost:3000/spidprotocol-docs) to preview the documentation locally.
59+
60+
---
61+
62+
## 🌐 Live Docs
63+
64+
You can explore the live documentation here:
65+
👉 **[spidprotocol.org/docs](https://spidprotocol.org/docs)** *(or your deployment link)*
66+
67+
---
68+
69+
## 🛠️ Core Concepts
70+
71+
- **Smart Packets** – AI-native, voice-powered messages
72+
- **SPID** – Unique identifier + resolver for every packet
73+
- **Intent Schema** – Machine-readable tags for AI inference
74+
- **PulseID** – Optional inbox layer for individuals and agents
75+
- **SPID Directory** – Registry of public Smart Packets and identities
76+
77+
---
78+
79+
## 🧩 Related Projects
80+
81+
- [`smartpacket.dev`](https://smartpacket.dev) – Smart Packet creator tools
82+
- [`voicemate.id`](https://voicemate.id) – Personal voice inboxes
83+
- [`spid.directory`](https://spid.directory) – Public Smart Packet directory
84+
85+
---
86+
87+
## 🤝 Contributing
88+
89+
We welcome open collaboration. To get involved:
90+
91+
- Fork the repo
92+
- Create a new branch
93+
- Submit a pull request
94+
95+
For major changes, please open an issue first to discuss scope and alignment with the protocol spec.
96+
97+
---
98+
99+
## 🧠 Learn More
100+
101+
SPID is designed to be a foundational protocol for a more human, async, AI-first future. This project is maintained by [ChatSites Labs](https://chatsites.ai) and its contributors.
102+
103+
For updates, roadmap, and use cases, visit:
104+
105+
👉 [spidprotocol.org](https://spidprotocol.org)
106+
👉 [docs.spidprotocol.org](https://spidprotocol.org/docs)
107+
108+
---
109+
110+
## 📄 License
111+
112+
This project is open-source under the [MIT License](LICENSE).
113+
114+
---
115+
116+
*Built for the era of structured, sovereign, and voice-ready communication.*

0 commit comments

Comments
 (0)