feat: add readme template

charmbracelet / .github

Default community health files

2 stars 1 forks source link

feat: add readme template #1

Open aymanbagabas opened 2 years ago

aymanbagabas commented 2 years ago

Add organization readme with our repositories

bashbunni commented 2 years ago

Ah I think this would be worth discussing in our weekly meeting!

aymanbagabas commented 2 years ago

This would be useful here https://github.com/muesli/markscribe/pull/48 instead of using Github Atom feed to determine the last release, we could use this to get the number of stars, last release, and description straight from the Github API. So updating a repo's description from the repo's page will automatically update it here.

bashbunni commented 3 months ago

I tried using the markscribe on master to include ayman's commit there, but got immediately rate limited for the GH API. Atom gave good results. Either way, it's important to have examples here. Would be cool to use a template to generate this README in the future with examples, but we would need to host 'em in a single spot following a naming convention. For now, it's a lower lift to use the README I wrote up

bashbunni commented 3 months ago

TODO: need to add a different charm logo at the top probably @meowgorithm

preview: https://github.com/charmbracelet/.github/tree/add-readme/profile

bashbunni commented 2 months ago

Ready for review!

bashbunni commented 2 months ago

[x] fix link to profile/CHARMWORLD.md (let's move charmworld to another iteration)
[x] link blog author names to GitHub profiles
[x] link to each of the repos
[x] sort repos by most recently released -> blog posts and repos
[x] what we've been working on: latest releases/activity for repo ordering instead of the projects that are currently there
[x] change "what's the 411?"
[x] remove charm world for now, link to those demos in for the featured projects section
[x] remove feedback + license
[x] log uses dynamic charm logo - use purple for light and cream for dark (N/A)
[x] figure out where "last released on a long while ago" comes from in the templates (N/A)

bashbunni commented 4 weeks ago

View here https://github.com/charmbracelet/.github/tree/add-readme/profile