feat: add readme template #1
Conversation
templates/README.md.tpl
Outdated
| @@ -0,0 +1,50 @@ | |||
| ### Repos | |||
There was a problem hiding this comment.
I feel like before getting into the repos, we should plug our website, twitter, and youtube to let them know that we have an active online presence and encourage them to join the community. Ideally once we start hosting regular events (tbd on dates) we can feature that here too so they can join in!
There was a problem hiding this comment.
these info are already included in the overview header
templates/README.md.tpl
Outdated
| - Wish List: The SSH directory ✨ [{{ .Title }}]({{ .URL }}) (_released {{ humanize .PublishedAt }}_) | ||
| {{- end }} | ||
|
|
||
| ### Getting in touch |
There was a problem hiding this comment.
This could be at the top and possibly changed to "Join the Community" or "Join the Community, We Have Cookies/mochi/ice cream/etc"
|
Ah I think this would be worth discussing in our weekly meeting! |
|
This would be useful here muesli/markscribe#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. |
|
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 |
|
TODO: need to add a different charm logo at the top probably @meowgorithm preview: https://github.com/charmbracelet/.github/tree/add-readme/profile |
|
Ready for review! |
There was a problem hiding this comment.
What's the difference between AUTOREADME.md and README.md? @bashbunni keep in mind that the current markscribe workflow will use templates/README.md.tpl to generate profile/README.md
https://github.com/charmbracelet/.github/blob/main/.github/workflows/readme-scribe.yml
|
* add stargazing section * refactor: update README * refactor: use updated orgPopularRepos * refactor: reformat blog section * refactor(README): improve layout of blogz * refactor(README): remove outdated section * refactor: use updated popularRepos function * feat: map authors in template file
Add organization readme with our repositories