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

feat: add readme template #1

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/readme-scribe.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
steps:
- uses: actions/checkout@master

- uses: muesli/readme-scribe@master
- uses: charmbracelet/readme-scribe@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
Expand All @@ -27,4 +27,5 @@ jobs:
branch: main
commit_user_name: readme-scribe 🤖
commit_user_email: actions@github.com
commit_author: readme-scribe 🤖 <actions@github.com>
commit_author: readme-scribe 🤖 <actions@github.com>

92 changes: 92 additions & 0 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@


### Stargazing
- 26,695 ⭐️ [bubbletea](https://github.com/charmbracelet/bubbletea) - A powerful little TUI framework 🏗 [_v1.1.1_](https://github.com/charmbracelet/bubbletea/releases/tag/v1.1.1)
- 17,785 ⭐️ [gum](https://github.com/charmbracelet/gum) - A tool for glamorous shell scripts 🎀 [_v0.14.5_](https://github.com/charmbracelet/gum/releases/tag/v0.14.5)
- 15,839 ⭐️ [glow](https://github.com/charmbracelet/glow) - Render markdown on the CLI, with pizzazz! 💅🏻 [_v2.0.0_](https://github.com/charmbracelet/glow/releases/tag/v2.0.0)
- 14,773 ⭐️ [vhs](https://github.com/charmbracelet/vhs) - Your CLI home video recorder 📼 [_v0.8.0_](https://github.com/charmbracelet/vhs/releases/tag/v0.8.0)
- 7,883 ⭐️ [lipgloss](https://github.com/charmbracelet/lipgloss) - Style definitions for nice terminal layouts 👄 [_v0.13.0_](https://github.com/charmbracelet/lipgloss/releases/tag/v0.13.0)
- 5,352 ⭐️ [bubbles](https://github.com/charmbracelet/bubbles) - TUI components for Bubble Tea 🫧 [_v0.20.0_](https://github.com/charmbracelet/bubbles/releases/tag/v0.20.0)
- 5,192 ⭐️ [soft-serve](https://github.com/charmbracelet/soft-serve) - The mighty, self-hostable Git server for the command line🍦 [_v0.7.6_](https://github.com/charmbracelet/soft-serve/releases/tag/v0.7.6)
- 4,064 ⭐️ [huh](https://github.com/charmbracelet/huh) - Build terminal forms and prompts 🤷🏻‍♀️ [_v0.6.0_](https://github.com/charmbracelet/huh/releases/tag/v0.6.0)
- 3,466 ⭐️ [wish](https://github.com/charmbracelet/wish) - Make SSH apps, just like that! 💫 [_v1.4.3_](https://github.com/charmbracelet/wish/releases/tag/v1.4.3)
- 3,136 ⭐️ [freeze](https://github.com/charmbracelet/freeze) - Generate images of code and terminal output 📸 [_v0.1.6_](https://github.com/charmbracelet/freeze/releases/tag/v0.1.6)

> Charm repos, sorted by star power.

### What we're hackin' on
- [bubbletea](https://github.com/charmbracelet/bubbletea) - A powerful little TUI framework 🏗 (_last updated today_)
- [winget-pkgs](https://github.com/charmbracelet/winget-pkgs) - The Microsoft community Windows Package Manager manifest repository (_last updated today_)
- [scoop-bucket](https://github.com/charmbracelet/scoop-bucket) - Charmbracelet Scoop Bucket (_last updated today_)
- [homebrew-tap](https://github.com/charmbracelet/homebrew-tap) - Our homebrew tap 🍺 (_last updated today_)
- [nur](https://github.com/charmbracelet/nur) (_last updated today_)
- [mods](https://github.com/charmbracelet/mods) - AI on the command line (_last updated today_)
- [bubbles](https://github.com/charmbracelet/bubbles) - TUI components for Bubble Tea 🫧 (_last updated today_)
- [x](https://github.com/charmbracelet/x) - Charm experimental packages (_last updated today_)

### Latest releases
- [mods](https://github.com/charmbracelet/mods) - AI on the command line [_v1.6.0_](https://github.com/charmbracelet/mods/releases/tag/v1.6.0) today
- [bubbletea](https://github.com/charmbracelet/bubbletea) - A powerful little TUI framework 🏗 [_v1.1.1_](https://github.com/charmbracelet/bubbletea/releases/tag/v1.1.1) 1 day ago
- [vhs](https://github.com/charmbracelet/vhs) - Your CLI home video recorder 📼 [_v0.8.0_](https://github.com/charmbracelet/vhs/releases/tag/v0.8.0) 6 days ago
- [gum](https://github.com/charmbracelet/gum) - A tool for glamorous shell scripts 🎀 [_v0.14.5_](https://github.com/charmbracelet/gum/releases/tag/v0.14.5) 6 days ago
- [huh](https://github.com/charmbracelet/huh) - Build terminal forms and prompts 🤷🏻‍♀️ [_v0.6.0_](https://github.com/charmbracelet/huh/releases/tag/v0.6.0) 6 days ago
- [bubbles](https://github.com/charmbracelet/bubbles) - TUI components for Bubble Tea 🫧 [_v0.20.0_](https://github.com/charmbracelet/bubbles/releases/tag/v0.20.0) 6 days ago
- [wish](https://github.com/charmbracelet/wish) - Make SSH apps, just like that! 💫 [_v1.4.3_](https://github.com/charmbracelet/wish/releases/tag/v1.4.3) 1 week ago
- [skate](https://github.com/charmbracelet/skate) - A personal key value store 🛼 [_v1.0.0_](https://github.com/charmbracelet/skate/releases/tag/v1.0.0) 2 weeks ago

### Fresh n' juicy news

Wanna see what the community is up to? There's now a dedicated space for
community-owned tools built with Charm. Join the crew in the new [Charm and
Friends](https://github.com/charm-and-friends) GitHub org. Give your
own projects the spotlight, contribute to open source, and hang with other
terminal lovers.

See you there!

### A glamorous blog

#### [Leveling up Cryptography @ Charm](https://charm.sh/blog/geomys/)

_Two cryptographers walk into a bar. Nobody else has a clue what they're talking about._
<br/>
🩷 by [bashbunni](https://github.com/bashbunni) (2 months ago)
<br/>

#### [A coffee shop for your terminal](https://charm.sh/blog/terminaldotshop/)

_coffee acquired @ ssh terminal.shop_
<br/>
🩷 by [bashbunni](https://github.com/bashbunni) (3 months ago)
<br/>

#### [Identifying Trends in Your Repos’ Issues…with AI!](https://charm.sh/blog/gh-mods-pop/)

_Get a summary of your project's issues sent to your inbox with Mods and Pop_
<br/>
🩷 by [bashbunni](https://github.com/bashbunni) (4 months ago)
<br/>

#### [This is How We Do It](https://charm.sh/blog/100k/)

_How we build popular open source software_
<br/>
🩷 by [meowgorithm](https://github.com/meowgorithm) (6 months ago)
<br/>

#### [2023 Charm Wrapped!](https://charm.sh/blog/2023-roundup/)

_Charm’s 2023 highlights_
<br/>
🩷 by [charmbracelet](https://github.com/charmbracelet) (8 months ago)
<br/>

There's [more](https://charm.sh/blog) where that came from...

***

Part of [Charm](https://charm.sh).

<a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>

Charm热爱开源 • Charm loves open source
55 changes: 55 additions & 0 deletions templates/README.md.tpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{{ $authors := dict "Christian Rocha" "meowgorithm" "Bashbunni" "bashbunni" "Ayman Bagabas" "aymanbagabas" "Carlos Becker" "caarlos0" "Maas Lalani" "maaslalani" "Charm" "charmbracelet"}}

### Stargazing

{{- range popularRepos "charmbracelet" 10}}
{{- with repo "charmbracelet" .Name}}
- {{ humanize .Stargazers}} ⭐️ [{{.Name}}]({{.URL}}){{with .Description}} - {{.}}{{end}} [_{{.LastRelease.TagName}}_]({{.LastRelease.URL}})
{{- end}}
{{- end}}

> Charm repos, sorted by star power.

### What we're hackin' on

{{- range recentPushedRepos "charmbracelet" 8}}
- [{{.Name}}]({{.URL}}){{with .Description}} - {{.}}{{end}} (_last updated {{humanize .PushedAt}}_)
{{- end}}

### Latest releases

{{- range latestReleasedRepos "charmbracelet" 8}}
- [{{.Name}}]({{.URL}}){{with .Description}} - {{.}}{{end}} [_{{.LastRelease.TagName}}_]({{.LastRelease.URL}}) {{ humanize .LastRelease.PublishedAt}}
{{- end}}

### Fresh n' juicy news

Wanna see what the community is up to? There's now a dedicated space for
community-owned tools built with Charm. Join the crew in the new [Charm and
Friends](https://github.com/charm-and-friends) GitHub org. Give your
own projects the spotlight, contribute to open source, and hang with other
terminal lovers.

See you there!

### A glamorous blog

{{- range rss "https://charm.sh/blog/rss.xml" 5}}

#### [{{.Title}}]({{.URL}})

_{{.Description}}_
<br/>
🩷 by [{{get $authors .Author }}](https://github.com/{{get $authors .Author}}) ({{humanize .PublishedAt}})
<br/>
{{- end}}

There's [more](https://charm.sh/blog) where that came from...

***

Part of [Charm](https://charm.sh).

<a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>

Charm热爱开源 • Charm loves open source