chore: rename quicproquo → quicprochat in docs, Docker, CI, and packaging
Rename all project references from quicproquo/qpq to quicprochat/qpc across documentation, Docker configuration, CI workflows, packaging scripts, operational configs, and build tooling. - Docker: crate paths, binary names, user/group, data dirs, env vars - CI: workflow crate references, binary names, artifact names - Docs: all markdown files under docs/, SDK READMEs, book.toml - Packaging: OpenWrt Makefile, init script, UCI config (file renames) - Scripts: justfile, dev-shell, screenshot, cross-compile, ai_team - Operations: Prometheus config, alert rules, Grafana dashboard - Config: .env.example (QPQ_* → QPC_*), CODEOWNERS paths - Top-level: README, CONTRIBUTING, ROADMAP, CLAUDE.md
This commit is contained in:
@@ -1,16 +1,16 @@
|
||||
# quicproquo Go SDK
|
||||
# quicprochat Go SDK
|
||||
|
||||
Go client library for the [quicproquo](https://github.com/nicholasgasior/quicproquo) E2E encrypted messenger.
|
||||
Go client library for the [quicprochat](https://github.com/nicholasgasior/quicprochat) E2E encrypted messenger.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Go 1.21+
|
||||
- A running quicproquo server
|
||||
- A running quicprochat server
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
go get quicproquo.dev/sdk/go
|
||||
go get quicprochat.dev/sdk/go
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
@@ -22,14 +22,14 @@ import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"quicproquo.dev/sdk/go/qpq"
|
||||
"quicprochat.dev/sdk/go/qpc"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
// Connect to a local server (dev mode)
|
||||
client, err := qpq.Connect(ctx, qpq.Options{
|
||||
client, err := qpc.Connect(ctx, qpc.Options{
|
||||
Addr: "127.0.0.1:5001",
|
||||
InsecureSkipVerify: true,
|
||||
})
|
||||
@@ -68,7 +68,7 @@ func main() {
|
||||
|
||||
| Method | Description |
|
||||
|---|---|
|
||||
| `qpq.Connect(ctx, opts)` | Connect to a server, returns `*Client` |
|
||||
| `qpc.Connect(ctx, opts)` | Connect to a server, returns `*Client` |
|
||||
| `client.Close()` | Disconnect |
|
||||
|
||||
### Authentication
|
||||
@@ -106,7 +106,7 @@ For testing without OPAQUE, use `SetSessionToken` with a token obtained by other
|
||||
|
||||
- `proto/node/` -- Generated Cap'n Proto Go types from `schemas/node.capnp`
|
||||
- `transport/` -- QUIC + TLS 1.3 transport and Cap'n Proto RPC framing
|
||||
- `qpq/` -- High-level client API (auth, messaging, channels)
|
||||
- `qpc/` -- High-level client API (auth, messaging, channels)
|
||||
- `cmd/example/` -- Example usage
|
||||
|
||||
## Regenerating Proto Types
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Command example demonstrates basic usage of the quicproquo Go SDK.
|
||||
// Command example demonstrates basic usage of the quicprochat Go SDK.
|
||||
package main
|
||||
|
||||
import (
|
||||
@@ -6,7 +6,7 @@ import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"quicproquo.dev/sdk/go/qpq"
|
||||
"quicprochat.dev/sdk/go/qpq"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
module quicproquo.dev/sdk/go
|
||||
module quicprochat.dev/sdk/go
|
||||
|
||||
go 1.25.7
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# node.capnp — Go-annotated copy of the quicproquo node schema.
|
||||
# node.capnp — Go-annotated copy of the quicprochat node schema.
|
||||
# This adds Go package annotations needed by capnpc-go.
|
||||
@0xd5ca5648a9cc1c28;
|
||||
|
||||
using Go = import "/go.capnp";
|
||||
$Go.package("node");
|
||||
$Go.import("quicproquo.dev/sdk/go/proto/node");
|
||||
$Go.import("quicprochat.dev/sdk/go/proto/node");
|
||||
|
||||
interface NodeService {
|
||||
uploadKeyPackage @0 (identityKey :Data, package :Data, auth :Auth) -> (fingerprint :Data);
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Package qpq provides the high-level Go API for interacting with a quicproquo server.
|
||||
// Package qpq provides the high-level Go API for interacting with a quicprochat server.
|
||||
//
|
||||
// It wraps the generated Cap'n Proto types and transport layer into an
|
||||
// ergonomic client that handles authentication, key management, and messaging.
|
||||
@@ -8,11 +8,11 @@ import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"quicproquo.dev/sdk/go/proto/node"
|
||||
"quicproquo.dev/sdk/go/transport"
|
||||
"quicprochat.dev/sdk/go/proto/node"
|
||||
"quicprochat.dev/sdk/go/transport"
|
||||
)
|
||||
|
||||
// Options configures the connection to a quicproquo server.
|
||||
// Options configures the connection to a quicprochat server.
|
||||
type Options struct {
|
||||
// Addr is the host:port of the server (e.g. "127.0.0.1:5001").
|
||||
Addr string
|
||||
@@ -30,7 +30,7 @@ type Message struct {
|
||||
Data []byte
|
||||
}
|
||||
|
||||
// Client is the high-level quicproquo client.
|
||||
// Client is the high-level quicprochat client.
|
||||
type Client struct {
|
||||
conn *transport.Connection
|
||||
token []byte // session token from OPAQUE login
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Package transport provides the low-level QUIC+TLS connection to a quicproquo server
|
||||
// Package transport provides the low-level QUIC+TLS connection to a quicprochat server
|
||||
// and bootstraps the Cap'n Proto RPC client over a single bidirectional QUIC stream.
|
||||
package transport
|
||||
|
||||
@@ -14,10 +14,10 @@ import (
|
||||
"capnproto.org/go/capnp/v3/rpc"
|
||||
"github.com/quic-go/quic-go"
|
||||
|
||||
"quicproquo.dev/sdk/go/proto/node"
|
||||
"quicprochat.dev/sdk/go/proto/node"
|
||||
)
|
||||
|
||||
// ConnectOptions configures the connection to a quicproquo server.
|
||||
// ConnectOptions configures the connection to a quicprochat server.
|
||||
type ConnectOptions struct {
|
||||
// Addr is the host:port of the server (e.g. "127.0.0.1:5001").
|
||||
Addr string
|
||||
|
||||
Reference in New Issue
Block a user