From bb2f218cec8782e89c02937d13d14f7cf7ffde71 Mon Sep 17 00:00:00 2001 From: "Juraj K." <140317448+mostypc123@users.noreply.github.com> Date: Sun, 5 Jan 2025 19:26:32 +0100 Subject: [PATCH 1/5] add website usage to readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 45f54ff23..2b33f8982 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ We look forward to seeing you there! ## 🚀 Quick Start - +### Using the CLI Tool You can try Repomix instantly in your project directory without installation: ```bash @@ -71,6 +71,8 @@ repomix That's it! Repomix will generate a `repomix-output.txt` file in your current directory, containing your entire repository in an AI-friendly format. +### Using The Website +Want to try it quickly? Visit the official website at [repomix.com](https://repomix.com). Simply enter your repository name, fill in any optional details, and click the **Pack** button to see your generated output. ## 📊 Usage From 5c95812f7eb14a5d96ff0ead54766e871eeec1c0 Mon Sep 17 00:00:00 2001 From: "Juraj K." <140317448+mostypc123@users.noreply.github.com> Date: Sun, 5 Jan 2025 19:28:39 +0100 Subject: [PATCH 2/5] improve website & discord section --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2b33f8982..bd334257a 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@

-Use Repomix online! 👉 repomix.com
-Need discussion? Join us on Discord! + Use Repomix online! 👉 repomix.com
+ Need discussion? Join us on Discord!

@@ -28,11 +28,10 @@ It is perfect for when you need to feed your codebase to Large Language Models ( ## 🎉 New: Repomix Website & Discord Community! -Try Repomix in your browser at [repomix.com](https://repomix.com/) +- Try Repomix in your browser at [repomix.com](https://repomix.com/) +- Join our [Discord Server](https://discord.gg/wNYzTwZFku) for support and discussion -Join our Discord [discord.gg/wNYzTwZFku](https://discord.gg/wNYzTwZFku) for support and discussion - -We look forward to seeing you there! +**We look forward to seeing you there!** ## 🌟 Features From 1081f22b82c4bb9992d98d8f999dc98d155e26bd Mon Sep 17 00:00:00 2001 From: "Juraj K." <140317448+mostypc123@users.noreply.github.com> Date: Sun, 5 Jan 2025 19:37:13 +0100 Subject: [PATCH 3/5] improve readme as coderabbitai suggested --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index bd334257a..38b0d38ed 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,11 @@

Use Repomix online! 👉 repomix.com
Need discussion? Join us on Discord! +

@@ -73,6 +78,12 @@ That's it! Repomix will generate a `repomix-output.txt` file in your current dir ### Using The Website Want to try it quickly? Visit the official website at [repomix.com](https://repomix.com). Simply enter your repository name, fill in any optional details, and click the **Pack** button to see your generated output. +#### Available Options +The website offers several convenient features: +- Customizable output format (Plain Text, XML, or Markdown) +- Instant token count estimation +- Much more! + ## 📊 Usage From 9ecb902806a2158d6c8e6a2cc2f4e610cd3d3190 Mon Sep 17 00:00:00 2001 From: Kazuki Yamada Date: Mon, 6 Jan 2025 21:47:48 +0900 Subject: [PATCH 4/5] docs(readme): Improve Discord section and add icons to headings in README --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 38b0d38ed..02832bce8 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,13 @@

Use Repomix online! 👉 repomix.com
- Need discussion? Join us on Discord! -

+

+ +

+ Need discussion? Join us on Discord!
+ Share your experience and tips
+ Stay updated on new features
+ Get help with configuration and usage

@@ -50,7 +51,7 @@ It is perfect for when you need to feed your codebase to Large Language Models ( ## 🚀 Quick Start -### Using the CLI Tool +### Using the CLI Tool `>_` You can try Repomix instantly in your project directory without installation: ```bash @@ -75,7 +76,7 @@ repomix That's it! Repomix will generate a `repomix-output.txt` file in your current directory, containing your entire repository in an AI-friendly format. -### Using The Website +### Using The Website 🌐 Want to try it quickly? Visit the official website at [repomix.com](https://repomix.com). Simply enter your repository name, fill in any optional details, and click the **Pack** button to see your generated output. #### Available Options From ac477e686fd5bf935ec8ee1b9cfb3c68325bb899 Mon Sep 17 00:00:00 2001 From: Kazuki Yamada Date: Mon, 6 Jan 2025 21:56:33 +0900 Subject: [PATCH 5/5] feat(docs): Add docker emoji --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 02832bce8..d3fdc1a68 100644 --- a/README.md +++ b/README.md @@ -134,9 +134,9 @@ repomix --init Once you have generated the packed file, you can use it with Generative AI tools like Claude, ChatGPT, and Gemini. -### Docker Usage +### Docker Usage 🐳 -You can also run Repomix using Docker 🐳 +You can also run Repomix using Docker. This is useful if you want to run Repomix in an isolated environment or prefer using containers. Basic usage (current directory):