Skip to content

Commit 843e318

Browse files
committed
docs: readme
1 parent 3fd377b commit 843e318

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,13 @@ go get github.com/goforj/httpx
8686

8787
## Documentation
8888

89-
The full API reference below is generated directly from source and kept in sync with the codebase.
89+
**API Reference & Examples**
9090

91-
All runnable examples are generated from doc comments and live in `./examples`.
91+
The full API reference below is generated directly from source and always reflects the current codebase.
9292

93-
They are compiled by `example_compile_test.go` and ran in CI to keep docs and code in sync.
93+
All runnable examples live in [`./examples`](./examples) and are generated from doc comments.
94+
95+
They are compiled and executed in CI to ensure the documentation stays accurate and up to date.
9496

9597
## Contributing
9698

0 commit comments

Comments
 (0)