Better README
Open
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 867
- Forks
- 73
- PR merge metrics
- No merged PRs in 30d
Description
Hey @jpsim, your lib is awesome but your README lacks information.
I created this iOS README template to help you out 😉
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.
Research direction
Start by reading the repository's README and compare its coverage with the linked iOS README template. Identify which important project information is missing, then update the README with relevant sections and verify that the resulting guide is accurate for PeerKit users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100