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.

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

[Lobe i18n] Improve Usage section for better onboarding experience #157

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

shinshin86
Copy link
Contributor

💻 变更类型 | Change Type

  • ✨ feat
  • 🐛 fix
  • ♻️ refactor
  • 💄 style
  • 🔨 chore
  • 📝 docs

🔀 变更说明 | Description of Change

Background:
When I first tried using Lobe i18n, I encountered some confusion in the Usage section of the README.
Specifically, the need to create a configuration file (e.g., .i18nrc.js) before running commands like lobe-i18n wasn’t immediately clear.

Proposal:
This PR updates the Usage section to include:

  1. A step-by-step guide for initializing the configuration.
  2. An example of a .i18nrc.js configuration file.

Goal:
By making the setup process clearer, especially for first-time users, this PR aims to improve the onboarding experience.


Request for Review
I hope this change can contribute to enhancing the usability of Lobe i18n. Please let me know if there are any adjustments or improvements needed.

Thank you for your time and consideration!

📝 补充信息 | Additional Information

@lobehubbot
Copy link
Member

👍 @shinshin86

Thank you for raising your pull request and contributing to our Community
Please make sure you have followed our contributing guidelines. We will review it as soon as possible.
If you encounter any problems, please feel free to connect with us.
非常感谢您提出拉取请求并为我们的社区做出贡献,请确保您已经遵循了我们的贡献指南,我们会尽快审查它。
如果您遇到任何问题,请随时与我们联系。

@canisminor1990 canisminor1990 merged commit 09ce889 into lobehub:master Dec 2, 2024
2 checks passed
@lobehubbot
Copy link
Member

❤️ Great PR @shinshin86 ❤️

The growth of project is inseparable from user feedback and contribution, thanks for your contribution!
项目的成长离不开用户反馈和贡献,感谢您的贡献!

@shinshin86 shinshin86 deleted the add-usage-text branch December 2, 2024 22:07
@lobehubbot
Copy link
Member

🎉 This PR is included in version 1.20.2 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@lobehubbot
Copy link
Member

🎉 This PR is included in version 1.10.1 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@lobehubbot
Copy link
Member

🎉 This PR is included in version 2.15.3 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@lobehubbot
Copy link
Member

🎉 This PR is included in version 1.3.2 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@lobehubbot
Copy link
Member

🎉 This PR is included in version 1.4.3 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants