Skip to content

Commit

Permalink
fix: readme images
Browse files Browse the repository at this point in the history
  • Loading branch information
@meowgorithm @toby
meowgorithm authored and toby committed May 12, 2023
1 parent 5079e6c commit 8f4858f
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Mods!

<p>
<img src="https://github.com/charmbracelet/mods/assets/25087/0b8872df-7e43-44a7-a2ce-231acd0d2baa" width="630" alt="Mods product art and type treatment"/>
<img src="https://github.com/charmbracelet/mods/assets/25087/5442bf46-b908-47af-bf4e-60f7c38951c4" width="630" alt="Mods product art and type treatment"/>
<br>
<a href="https://github.com/charmbracelet/mods/releases"><img src="https://img.shields.io/github/release/charmbracelet/mods.svg" alt="Latest Release"></a>
<a href="https://github.com/charmbracelet/mods/actions"><img src="https://github.com/charmbracelet/mods/workflows/build/badge.svg" alt="Build Status"></a>
</p>

AI for the command line, built for pipelines.

<p><img src="https://github.com/charmbracelet/mods/assets/25087/ffaad9a3-1105-429f-a076-dae47ef01a07" width="900" alt="a GIF of mods running"></p>
<p><img src="https://github.com/charmbracelet/mods/assets/25087/347300c6-b382-462d-9f80-8520a27e14bb" width="900" alt="a GIF of mods running"></p>

LLM based AI is really good at interpreting the output of commands and
returning the results in CLI friendly text formats like Markdown. Mods is a
Expand Down Expand Up @@ -38,7 +38,7 @@ gives you a lot of options for refactoring, enhancing or debugging code.

`mods -f "what are your thoughts on improving this code?" < main.go | glow`

<p><img src="https://github.com/charmbracelet/mods/assets/25087/e4802dbe-2fb5-444e-a240-831a9865801f" width="900" alt="a GIF of mods offering code refactoring suggestions"></p>
<p><img src="https://github.com/charmbracelet/mods/assets/25087/738fe969-1c9f-4849-af8a-cde38156ce92" width="900" alt="a GIF of mods offering code refactoring suggestions"></p>

### Come Up With Product Features

Expand All @@ -47,15 +47,15 @@ README file).

`mods -f "come up with 10 new features for this tool." < main.go | glow`

<p><img src="https://github.com/charmbracelet/mods/assets/25087/667be64b-459e-4a5d-9e2c-e5e8697e5fea" width="900" alt="a GIF of mods suggesting feature improvements"></p>
<p><img src="https://github.com/charmbracelet/mods/assets/25087/025de860-798a-4ab2-b1cf-a0b32dbdbe4d" width="900" alt="a GIF of mods suggesting feature improvements"></p>

### Help Write Docs

Mods can quickly give you a first draft for new documentation.

`mods "write a new section to this readme for a feature that sends you a free rabbit if you hit r" | glow`

<p><img src="https://github.com/charmbracelet/mods/assets/25087/c653187b-a071-4599-82d1-f7023f954b15" width="900" alt="a GIF of mods contributing to a product README"></p>
<p><img src="https://github.com/charmbracelet/mods/assets/25087/c26a17a9-c772-40cc-b3f1-9189ac682730" width="900" alt="a GIF of mods contributing to a product README"></p>

### Organize Your Videos

Expand All @@ -65,7 +65,7 @@ editorialization of your content.

`ls ~/vids | mods -f "organize these by decade and summarize each" | glow`

<p><img src="https://github.com/charmbracelet/mods/assets/25087/0319568c-c87c-4f9d-980c-847ac95797f6" width="900" alt="a GIF of mods oraganizing and summarizing video from a shell ls statement"></p>
<p><img src="https://github.com/charmbracelet/mods/assets/25087/8204d06a-8cf1-401d-802f-2b94345dec5d" width="900" alt="a GIF of mods oraganizing and summarizing video from a shell ls statement"></p>

### Make Recommendations

Expand All @@ -77,7 +77,7 @@ well, both for similar content but also content in an entirely different media

`ls ~/vids | mods -f "recommend me 10 albums based on these shows, do not include any soundtrack music or music from the show" | glow`

<p><img src="https://github.com/charmbracelet/mods/assets/25087/300da607-2de7-42b2-9f5b-3de579ab0587" width="900" alt="a GIF of mods generating television show recommendations based on a file listing from a directory of videos"></p>
<p><img src="https://github.com/charmbracelet/mods/assets/25087/48159b19-5cae-413b-9677-dce8c6dfb6b8" width="900" alt="a GIF of mods generating television show recommendations based on a file listing from a directory of videos"></p>

### Read Your Fortune

Expand All @@ -86,7 +86,7 @@ files, but with Mods you can use that to your advantage!

`ls ~/Downloads | mods -f "tell my fortune based on these files" | glow`

<p><img src="https://github.com/charmbracelet/mods/assets/25087/23c5bc39-c4ba-43b9-b61e-e6b56da5a4d8" width="900" alt="a GIF of mods generating a fortune from the contents of a downloads directory"></p>
<p><img src="https://github.com/charmbracelet/mods/assets/25087/da2206a8-799f-4c92-b75e-bac66c56ea88" width="900" alt="a GIF of mods generating a fortune from the contents of a downloads directory"></p>

### Understand APIs

Expand All @@ -95,15 +95,15 @@ it to something human readable.

`curl "https://api.open-meteo.com/v1/forecast?latitude=29.00&longitude=-90.00&current_weather=true&hourly=temperature_2m,relativehumidity_2m,windspeed_10m" 2>/dev/null | mods -f "summarize this weather data for a human." | glow`

<p><img src="https://github.com/charmbracelet/mods/assets/25087/7f21bf79-af25-4800-9702-98b984f4f539" width="900" alt="a GIF of mods summarizing the weather from JSON API output"></p>
<p><img src="https://github.com/charmbracelet/mods/assets/25087/3af13876-46a3-4bab-986e-50d9f54d2921" width="900" alt="a GIF of mods summarizing the weather from JSON API output"></p>

### Read The Comments (so you don't have to)

Just like with APIs, Mods can read through raw HTML and summarize the contents.

`curl "https://news.ycombinator.com/item?id=30048332" 2>/dev/null | mods -f "what are the authors of these comments saying?" | glow`

<p><img src="https://github.com/charmbracelet/mods/assets/25087/563676a9-3355-4102-ab6b-9cfdfc537d8a" width="900" alt="a GIF of mods summarizing the comments on hacker news"></p>
<p><img src="https://github.com/charmbracelet/mods/assets/25087/e4d94ef8-43aa-45ea-9be5-fe13e53d5203" width="900" alt="a GIF of mods summarizing the comments on hacker news"></p>

## Installation

Expand Down Expand Up @@ -247,6 +247,14 @@ Your desired level of fanciness.

Output nothing to standard err.

## Whatcha Think?

We’d love to hear your thoughts on this project. Feel free to drop us a note.

* [Twitter](https://twitter.com/charmcli)
* [The Fediverse](https://mastodon.social/@charmcli)
* [Discord](https://charm.sh/chat)

## License

[MIT](https://github.com/charmbracelet/mods/raw/main/LICENSE)
Expand Down

0 comments on commit 8f4858f

Please sign in to comment.