Skip to content

docs: Simplify project rename notice and add discussion link #189

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

Merged
yamadashy merged 1 commit into from
Dec 1, 2024
Merged

docs: Simplify project rename notice and add discussion link #189

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,9 @@

Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file.
It is perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, and Gemini.

## 📢 Important Notice: Project Renamed to Repomix

> [!NOTE]
> Due to legal considerations, this project has been renamed from "Repopack" to "Repomix". Only the name is changing; Repomix all functionality and maintainer ([@yamadashy](https://github.com/yamadashy)) remain the same.
> We are committed to ensuring a smooth transition for all users.

### Migration Guide

To continue using the tool, simply install the new package:
```bash
# Install new package
npm install -g repomix

# Or use directly with npx
npx repomix
```

Optionally, you can also uninstall the old package:
```bash
npm uninstall -g repopack
```

#### Configuration Files
Your existing configuration files (`repopack.config.json` and `.repopackignore`) will continue to work during the transition period.
`repomix` will automatically detect these files and offer to migrate them to the new format (`repomix.config.json` and `.repomixignore`).

#### Timeline
- Current: Transition period begins
- December 1st, 2024: Ownership of the [repopack npm package](https://npmjs.com/repopack) will be transferred to another party. The repomix package will continue to be maintained as usual

We appreciate your understanding and cooperation during this transition.
> For detailed information about this transition and migration guide, please visit our [Discussion](https://github.com/yamadashy/repomix/discussions/188).

## 🌟 Features

Expand Down