docs: add readmes to each of the publishable packages (#86)

iftekharanwar · Ubuntu · Devin · web-flow · commit fa54c4f0c916 · 2024-05-11T13:00:10.000+02:00
* Add stub README.md files to npm packages * feat: add dynamic page for Next.js pages router compatibility update pnpm-lock.yaml to reflect new dependencies * refactor: move dynamic [id] page into something directory for correct routing * refactor: remove old [id].tsx file after moving to something directory * feat(nextjs): add dynamic page routing support * docs: enhance README documentation for all packages * docs: remove notes section from PR description * docs: remove Getting Started section from READMEs * chore: delete PR_DESCRIPTION.md file * chore: remove PR_DESCRIPTION.md * Revert "feat: add dynamic page for Next.js pages router compatibility" This reverts commit 411ef14. --------- Co-authored-by: Ubuntu <ubuntu@ip-10-240-134-251.us-west-2.compute.internal> Co-authored-by: Devin <devin@example.com> Co-authored-by: iftekharanwar <iftekharanwar@example.com>
diff --git a/demo/next-pages/src/pages/something/[id].tsx b/demo/next-pages/src/pages/something/[id].tsx
@@ -0,0 +1,15 @@
+import { useRouter } from 'next/router';
+
+const DynamicPage = () => {
+  const router = useRouter();
+  const { id } = router.query;
+
+  return (
+    <div>
+      <h1>Dynamic Page</h1>
+      <p>ID: {id}</p>
+    </div>
+  );
+};
+
+export default DynamicPage;
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -0,0 +1,23 @@
+# Replexica CLI Package
+
+This package is part of the [Replexica](https://github.com/replexica/replexica) project, an i18n toolkit for React designed to help you ship multi-language apps quickly.
+
+## Overview
+
+The Replexica CLI is a command-line interface for interacting with the Replexica platform. It provides a set of tools to manage translations and integrate with the Replexica API, streamlining the process of internationalizing your React applications.
+
+## Features
+
+- **Translation Management**: Simplify the process of adding, updating, and deleting translations across your projects.
+- **Integration with Replexica API**: Seamlessly interact with the Replexica API to fetch and push translation data.
+- **Automation**: Automate repetitive tasks related to internationalization, saving time and reducing errors.
+
+## Contributing
+
+Contributions to the Replexica CLI are welcome! Please read our [contributing guidelines](https://github.com/replexica/replexica/blob/main/CONTRIBUTING.md) to learn how you can help improve this tool.
+
+## License
+
+The Replexica CLI is released under the [MIT License](https://github.com/replexica/replexica/blob/main/LICENSE). Feel free to use and modify the code in accordance with this license.
+
+For more information and usage instructions, please refer to the main [Replexica repository](https://github.com/replexica/replexica).
diff --git a/packages/compiler/README.md b/packages/compiler/README.md
@@ -0,0 +1,23 @@
+# Replexica Compiler Package
+
+This package is part of the [Replexica](https://github.com/replexica/replexica) project, an i18n toolkit for React designed to help you ship multi-language apps quickly and efficiently.
+
+## Overview
+
+The Replexica Compiler is an open-source compiler plugin for React. It is currently experimental and supports the Next.js App Router only. The compiler is designed to optimize the internationalization process by automating the compilation of language resources.
+
+## Features
+
+- **Next.js App Router Support**: Seamlessly integrates with the Next.js App Router, providing a smooth development experience for multi-language Next.js applications.
+- **Automated Compilation**: Automatically compiles language resources, reducing manual effort and potential for human error.
+- **Open Source**: Encourages community contributions and collaboration to continuously improve the compiler's capabilities.
+
+## Contributing
+
+We welcome contributions to the Replexica Compiler. If you're interested in contributing, please read our [contributing guidelines](https://github.com/replexica/replexica/blob/main/CONTRIBUTING.md) for more information on how to get started.
+
+## License
+
+The Replexica Compiler is released under the [MIT License](https://github.com/replexica/replexica/blob/main/LICENSE). Feel free to use and modify the code in your own projects.
+
+For more detailed information and usage instructions, please refer to the main [Replexica repository](https://github.com/replexica/replexica).
diff --git a/packages/react/README.md b/packages/react/README.md
@@ -0,0 +1,23 @@
+# Replexica React Package
+
+This package is part of the [Replexica](https://github.com/replexica/replexica) project, an i18n toolkit for React designed to help you ship multi-language apps quickly.
+
+## Overview
+
+The Replexica React package provides React components and hooks that make it easy to integrate the Replexica i18n toolkit into your React applications.
+
+## Features
+
+- **Easy Integration**: Utilize components and hooks to easily integrate internationalization into your React app.
+- **Customizable**: Flexible API to customize your i18n setup to fit your project's needs.
+- **Performance Optimized**: Built with performance in mind to ensure a seamless user experience.
+
+## Contributing
+
+We welcome contributions to the Replexica React package. If you're interested in contributing, please read our [contributing guidelines](https://github.com/replexica/replexica/blob/main/CONTRIBUTING.md) for more information on how to get started.
+
+## License
+
+The Replexica React package is released under the [MIT License](https://github.com/replexica/replexica/blob/main/LICENSE). Feel free to use and modify the code in your own projects.
+
+For more detailed information and usage instructions, please refer to the main [Replexica repository](https://github.com/replexica/replexica).
diff --git a/packages/spec/README.md b/packages/spec/README.md
@@ -0,0 +1,23 @@
+# Replexica Spec Package
+
+This package is part of the [Replexica](https://github.com/replexica/replexica) project, an i18n toolkit for React designed to help you ship multi-language apps quickly.
+
+## Overview
+
+The Replexica Spec package contains the specifications and schemas used by the Replexica toolkit. It defines the structure and rules for translation files and other i18n resources, ensuring consistency and reliability across your internationalized applications.
+
+## Features
+
+- **Structured Specifications**: Provides a clear and consistent structure for translation files and i18n resources.
+- **Schema Validation**: Ensures that your i18n resources meet the required specifications, preventing errors in translation implementation.
+- **Integration Ready**: Designed to work seamlessly with the Replexica toolkit, allowing for easy integration into your workflow.
+
+## Contributing
+
+Contributions to the Replexica Spec package are encouraged. If you would like to contribute, please review our [contributing guidelines](https://github.com/replexica/replexica/blob/main/CONTRIBUTING.md) for detailed instructions.
+
+## License
+
+The Replexica Spec package is released under the [MIT License](https://github.com/replexica/replexica/blob/main/LICENSE). This license allows for both personal and commercial use, modification, distribution, and private use of the code.
+
+For more detailed information and usage instructions, please refer to the main [Replexica repository](https://github.com/replexica/replexica).
