gt-next 6.11.1 → 6.11.3

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # gt-next
 
+## 6.11.3
+
+### Patch Changes
+
+- [#888](https://github.com/generaltranslation/gt/pull/888) [`6314624`](https://github.com/generaltranslation/gt/commit/6314624cd6d537e236e7208b1097dc137befab66) Thanks [@ErnestM1234](https://github.com/ErnestM1234)! - fix: readme
+
+- Updated dependencies [[`6314624`](https://github.com/generaltranslation/gt/commit/6314624cd6d537e236e7208b1097dc137befab66)]:
+  - gt-react@10.9.3
+
+## 6.11.2
+
+### Patch Changes
+
+- Updated dependencies [[`e113d8d`](https://github.com/generaltranslation/gt/commit/e113d8d8fb5e37f45a4aa77544e8f4666519bfe8)]:
+  - generaltranslation@8.1.3
+  - @generaltranslation/compiler@1.1.11
+  - gt-react@10.9.2
+  - @generaltranslation/supported-locales@2.0.33
+
 ## 6.11.1
 
 ### Patch Changes

package/README.md

@@ -16,89 +16,82 @@ Install `gt-next` via npm:
 
 ```bash
 npm install gt-next
-npm install gt-next-cli --save-dev
+npm install gtx-cli --save-dev
 ```
 
 ## Getting Started
 
-### Step 1: Configure Your Environment Variables
+Follow the [Quick Start Guide](https://generaltranslation.com/docs/next) or run the setup wizard: `npx gtx-cli init`.
 
-Add the following environment variables to your `.env` file:
+Translate everything inside of the `<T>` component.
 
-```bash
-GT_API_KEY="your-api-key"
-GT_PROJECT_ID="your-project-id"
+```jsx
+<T>
+  <p>This gets translated!</p>
+  <div>This also gets translated!</divs>
+</T>
 ```
 
-- Get your `API Key` and `Project ID` from the [General Translation Dashboard](https://generaltranslation.com).
-
-### 2. Add the `withGTConfig()` plugin
+## Documentation
 
-Add `withGTConfig()` to your `next.config.js` file.
-You can specify the languages you want to support by passing an array of [locale codes](https://generaltranslation.com/docs/platform/locale-strings#supported-locales).
+Full documentation, including guides, examples, and API references, can be found at [General Translation Docs](generaltranslation.com/docs).
 
-```js
-import { withGTConfig } from 'gt-next/config';
+## Features
 
-const nextConfig = {};
+### Jsx Translation
 
-export default withGTConfig(nextConfig, {
-  locales: ['pt', 'es'], // Support for Portuguese and Spanish
-  swcPluginOptions: {
-    logLevel: 'silent', // Control warning output
-    compileTimeHash: false, // Enable compile-time optimizations
-  },
-});
+```jsx
+<T>
+  Translate anything inside of a {'<T>'} component!
+  <div>Including nested structures</div>
+</T>
 ```
 
-### 3. Add the `<T>` component
-
-Wrap any nested JSX content in the `<T>` component to make it translatable.
-For more information, check out this [guide on using `<T>` components](https://generaltranslation.com/docs/next/reference/t-reference).
+### Inline string translation
 
 ```jsx
-import { T } from 'gt-next';
-
-export default function Example() {
-  return (
-    <T>
-      <p>This gets translated.</p>
-    </T>
-  );
+function MyComponent() {
+  const gt = useGT();
+  return <>{gt('Strings as well!')}</>;
 }
 ```
 
-Use the `<Var>` component to designate JSX content that should not be translated.
+### Dictionary translation
+
+```json
+{
+  "key": "Hello, World!"
+}
+```
 
 ```jsx
-import { T, Var } from 'gt-next';
-
-export default function Example() {
-  return (
-    <T>
-      <p>
-        This gets translated. <Var>This does not.</Var>
-      </p>
-    </T>
-  );
+function MyComponent() {
+  const t = useTranslations();
+  return <>{t('key')}</>;
 }
 ```
 
-**Tip:**
-To save time, run the setup command.
-It will scan your codebase for translatable JSX and insert the `<T>` tags for you.
+### Pluralization
 
-```bash
-npx gt-next-cli setup
+Support for pluralization and conditional branching
+
+```jsx
+<T>
+  <Plural
+    n={count}
+    singular="There is 1 person"
+    plural={<>There are <Num>{count}</Num> people}
+  />
+</T>
 ```
 
-**Strings:**
-For strings, you can use `useGT()` or `getGT()` for translation.
-For more information, check out [this guide](https://generaltranslation.com/docs/next/tutorials/translating-strings).
+### Formatting
 
-## Documentation
+Support for number, currency, date time, and dynamic variables
 
-Full documentation, including guides, examples, and API references, can be found at [General Translation Docs](generaltranslation.com/docs).
+```jsx
+<Num options={{ style: 'currency', currency: 'EUR' }}>{1000}</Num>
+```
 
 ## Contributing
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gt-next",
-  "version": "6.11.1",
+  "version": "6.11.3",
   "description": "A Next.js library for automatic internationalization.",
   "main": "dist/index.server.js",
   "peerDependencies": {
@@ -13,11 +13,11 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@generaltranslation/supported-locales": "2.0.32",
-    "@generaltranslation/compiler": "1.1.10",
+    "@generaltranslation/supported-locales": "2.0.33",
+    "@generaltranslation/compiler": "1.1.11",
     "@generaltranslation/next-internal": "0.1.0",
-    "generaltranslation": "8.1.2",
-    "gt-react": "10.9.1"
+    "generaltranslation": "8.1.3",
+    "gt-react": "10.9.3"
   },
   "repository": {
     "type": "git",