Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add content to READMEs #1238

Closed
5 tasks done
Frando opened this issue Jul 14, 2023 · 0 comments
Closed
5 tasks done

Add content to READMEs #1238

Frando opened this issue Jul 14, 2023 · 0 comments
Assignees
Labels
docs Improvements or additions to documentation

Comments

@Frando
Copy link
Member

Frando commented Jul 14, 2023

The READMEs in the repo (root and individual iroh crates) are mostly empty. The READMEs are displayed on crates.io and possibly other places once the crates are published, and also are usually the first entry point for people browsing the Github repo.

Would be great to add high-level descriptions of the crates and the repo there.

@Frando Frando added the docs Improvements or additions to documentation label Jul 14, 2023
@github-project-automation github-project-automation bot moved this to 📋 Backlog - unassigned issues in iroh Jul 14, 2023
@b5 b5 added this to the v0.5.0 - Connectivity intensifies milestone Jul 17, 2023
@b5 b5 self-assigned this Jul 17, 2023
@b5 b5 moved this from 📋 Backlog - unassigned issues to 🏗 In progress in iroh Jul 17, 2023
@b5 b5 moved this from 🏗 In progress to 👀 In review in iroh Jul 17, 2023
@b5 b5 closed this as completed Jul 18, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in iroh Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

2 participants