Update the README file
Open
@englishm is already working on this.
Since Jan 16, 2025.
- Dominant language
- TypeScript
- Stars
- 48
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the README does not reflect the current state of the project. For example, it mentions that the project can be tested on quic.video, but in reality, quic.video showcases the repository prior to the fork by Kixelated.
I believe the new README should:
- Mention that this repository is aligned with the IETF drafts of MoQ and include links to those drafts.
- Explain the system for tagging the different IETF drafts, in case someone wants to test a specific draft, like draft-04 of MoQ.
- Mention that this project can be tested alongside englishm/moq-rs.
- Provide instructions for setting up the development environment, suggesting and explaining how to start moq-rs.
- Explain the structure of the project, specifically noting that the library (lib) contains the player.
- Include instructions for building the player.
Any other ideas to include?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.