chore: README#76
Conversation
There was a problem hiding this comment.
Pull request overview
Replaces the placeholder README with a full project overview for nim-lsquic, including background, features, installation instructions, a Quick Start example, development notes, and module documentation.
Changes:
- Added a complete README describing the library’s purpose, API surface, and relationship to vendored
lsquic/BoringSSL submodules. - Added install/requirements and development workflow documentation (tests, formatting, FFI regeneration).
- Added a Quick Start example and a module index table.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [`tests/test_lifecycle.nim`](tests/test_lifecycle.nim) | ||
| - [`tests/test_verifier.nim`](tests/test_verifier.nim) | ||
| - [`tests/test_stress.nim`](tests/test_stress.nim) |
There was a problem hiding this comment.
The README links to test files that don't exist in this repository (tests/test_lifecycle.nim, tests/test_verifier.nim, tests/test_stress.nim). Please update this list to point at the actual test entry points (e.g., tests/test_connection.nim, tests/test_perf.nim, and/or tests/test_all.nim) or add the missing files if they are intended to exist.
| - [`tests/test_lifecycle.nim`](tests/test_lifecycle.nim) | |
| - [`tests/test_verifier.nim`](tests/test_verifier.nim) | |
| - [`tests/test_stress.nim`](tests/test_stress.nim) | |
| - [`tests/test_perf.nim`](tests/test_perf.nim) | |
| - [`tests/test_all.nim`](tests/test_all.nim) |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Module | Description | | ||
| | --- | --- | | ||
| | [`lsquic`](lsquic.nim) | Top-level import that re-exports the main public API | | ||
| | [`lsquic/lsquic`](lsquic/lsquic.nim) | Process-wide `lsquic` initialization and cleanup | | ||
| | [`lsquic/client`](lsquic/client.nim) | `QuicClient` creation, dialing, and transport shutdown | | ||
| | [`lsquic/server`](lsquic/server.nim) | `QuicServer`, `Listener`, binding, and `accept()` | | ||
| | [`lsquic/connection`](lsquic/connection.nim) | Connection lifecycle, stream creation, certificate access | | ||
| | [`lsquic/stream`](lsquic/stream.nim) | Async stream reads, writes, close, and abort | | ||
| | [`lsquic/tlsconfig`](lsquic/tlsconfig.nim) | TLS configuration plus PEM-to-X509/PKey helpers | |
There was a problem hiding this comment.
The Modules table is written with double leading pipes (|| ...) which creates an extra empty column and renders incorrectly on GitHub. Use standard Markdown table syntax with a single leading | per row (and matching header separator row) so the table displays as intended.
| | Module | Description | | |
| | --- | --- | | |
| | [`lsquic`](lsquic.nim) | Top-level import that re-exports the main public API | | |
| | [`lsquic/lsquic`](lsquic/lsquic.nim) | Process-wide `lsquic` initialization and cleanup | | |
| | [`lsquic/client`](lsquic/client.nim) | `QuicClient` creation, dialing, and transport shutdown | | |
| | [`lsquic/server`](lsquic/server.nim) | `QuicServer`, `Listener`, binding, and `accept()` | | |
| | [`lsquic/connection`](lsquic/connection.nim) | Connection lifecycle, stream creation, certificate access | | |
| | [`lsquic/stream`](lsquic/stream.nim) | Async stream reads, writes, close, and abort | | |
| | [`lsquic/tlsconfig`](lsquic/tlsconfig.nim) | TLS configuration plus PEM-to-X509/PKey helpers | | |
| | Module | Description | | |
| | --------------------------------------- | --------------------------------------------------------------- | | |
| | [`lsquic`](lsquic.nim) | Top-level import that re-exports the main public API | | |
| | [`lsquic/lsquic`](lsquic/lsquic.nim) | Process-wide `lsquic` initialization and cleanup | | |
| | [`lsquic/client`](lsquic/client.nim) | `QuicClient` creation, dialing, and transport shutdown | | |
| | [`lsquic/server`](lsquic/server.nim) | `QuicServer`, `Listener`, binding, and `accept()` | | |
| | [`lsquic/connection`](lsquic/connection.nim) | Connection lifecycle, stream creation, certificate access | | |
| | [`lsquic/stream`](lsquic/stream.nim) | Async stream reads, writes, close, and abort | | |
| | [`lsquic/tlsconfig`](lsquic/tlsconfig.nim) | TLS configuration plus PEM-to-X509/PKey helpers | |
No description provided.