diff --git a/README.md b/README.md index e808df747..5af95392e 100644 --- a/README.md +++ b/README.md @@ -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