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.

Sign up for GitHub

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

improve README.md #265

Merged
merged 5 commits into from
Jan 6, 2025
Merged

improve README.md #265

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bb2f218
add website usage to readme
mostypc123 Jan 5, 2025
5c95812
improve website & discord section
mostypc123 Jan 5, 2025
1081f22
improve readme as coderabbitai suggested
mostypc123 Jan 5, 2025
9ecb902
docs(readme): Improve Discord section and add icons to headings in RE…
yamadashy Jan 6, 2025
ac477e6
feat(docs): Add docker emoji
yamadashy Jan 6, 2025
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
31 changes: 22 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,14 @@
<hr />

<p align="center">
<a href="https://repomix.com"><b>Use Repomix online! 👉 repomix.com</b></a><br>
<i>Need discussion? Join us on <a href="https://discord.gg/wNYzTwZFku">Discord</a>!</i>
<a href="https://repomix.com"><b>Use Repomix online! 👉 repomix.com</b></a><br>
</p>

<p align="center">
Need discussion? Join us on <a href="https://discord.gg/wNYzTwZFku">Discord</a>!<br>
<i>Share your experience and tips</i><br>
<i>Stay updated on new features</i><br>
<i>Get help with configuration and usage</i><br>
</p>

<hr />
Expand All @@ -28,11 +34,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

Expand All @@ -46,7 +51,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
Expand All @@ -71,6 +76,14 @@ 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.

#### Available Options
The website offers several convenient features:
- Customizable output format (Plain Text, XML, or Markdown)
- Instant token count estimation
- Much more!


## 📊 Usage
Expand Down Expand Up @@ -121,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):
Expand Down
Loading