Update the content of the readme #216
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README content for the twirp and twirp-build crates to reflect their correct purposes after their locations were swapped in PR #215. The changes ensure that each README accurately describes its respective crate's functionality and includes proper documentation sections.
- Updates crate titles and descriptions to match their actual purposes
- Fixes relative links to use absolute GitHub URLs for better accessibility
- Adds standard project sections (MSRV, Getting Help, Contributing, License) to both READMEs
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| crates/twirp/README.md | Updates title from twirp-build to twirp, fixes relative links to absolute URLs, and adds standard project documentation sections |
| crates/twirp-build/README.md | Updates title from twirp to twirp-build, replaces brief description with detailed explanation of code generation functionality, and adds standard project documentation sections |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
|
||
| Unlike [`prost-twirp`](https://github.com/sourcefrog/prost-twirp), the generated traits for serving and accessing RPCs are implemented atop `async` functions. Because traits containing `async` functions [are not directly supported](https://smallcultfollowing.com/babysteps/blog/2019/10/26/async-fn-in-traits-are-hard/) in Rust versions prior to 1.75, this crate uses the [`async_trait`](https://github.com/dtolnay/async-trait) macro to encapsulate the scaffolding required to make them work. | ||
|
|
||
| ## Usage | ||
|
|
||
| See the [example](./example) for a complete example project. | ||
| See the [example](https://github.com/github/twirp-rs/tree/main/example) for a complete example project. |
There was a problem hiding this comment.
Question: Why absolute? The relative link will survive e.g. renaming the repo or moving it.
There was a problem hiding this comment.
If you view the readme from the file view in crates/twirp, the relative link is broken (try it here). The absolute link always works. I would prefer leaving the absolute links so that they work in all views. What do you think?
There was a problem hiding this comment.
Ah, right. If it is symlinked this has to be an absolute... Can't you still anchor to the repo root and avoid the http stuff?
There was a problem hiding this comment.
The readme is also rendered on crates.io. I don't think relative links to the repo work from there.
There was a problem hiding this comment.
Ah, good point, carry on then! Thanks @CleanCut.
This PR updates the content of the readme files after swapping their location in #215