We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 3fd377b commit 843e318Copy full SHA for 843e318
1 file changed
README.md
@@ -86,11 +86,13 @@ go get github.com/goforj/httpx
86
87
## Documentation
88
89
-The full API reference below is generated directly from source and kept in sync with the codebase.
+**API Reference & Examples**
90
91
-All runnable examples are generated from doc comments and live in `./examples`.
+The full API reference below is generated directly from source and always reflects the current codebase.
92
93
-They are compiled by `example_compile_test.go` and ran in CI to keep docs and code in sync.
+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.
96
97
## Contributing
98
0 commit comments