intlayer-cli 4.0.0 → 4.0.3

package/README.md

@@ -1,91 +1,68 @@
 <div align="center">
-  <a href="https://www.npmjs.com/package/intlayer">
+  <a href="https://www.npmjs.com/package/intlayer-cli">
     <img src="https://raw.githubusercontent.com/aymericzip/intlayer/572ae9c9acafb74307b81530c1931a8e98990aef/docs/assets/logo.png" width="500" alt="intlayer" />
   </a>
 </div>
 
 <div align="center">
-  <a href="https://www.npmjs.com/package/intlayer">
+  <a href="https://www.npmjs.com/package/intlayer-cli">
     <img alt="npm" src="https://img.shields.io/npm/v/intlayer.svg?labelColor=49516F&color=8994BC" />
   </a>
-  <a href="https://npmjs.org/package/intlayer">
+  <a href="https://npmjs.org/package/intlayer-cli">
     <img alt="downloads" src="https://badgen.net/npm/dm/intlayer?labelColor=49516F&color=8994BC" />
   </a>
-  <a href="https://npmjs.org/package/intlayer">
+  <a href="https://npmjs.org/package/intlayer-cli">
     <img alt="types included" src="https://badgen.net/npm/types/intlayer?labelColor=49516F&color=8994BC" 
   />
   </a>
 </div>
 
-# Intlayer: Next-Level Content Management in JavaScript
+# intlayer-cli: Use the Intlayer CLI
 
-**Intlayer** is an internationalization library designed specifically for JavaScript developers. It allow the declaration of your content everywhere in your code. It converts declaration of multilingual content into structured dictionaries to integrate easily in your code. Using TypeScript, **Intlayer** make your development stronger and more efficient.
+**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like React, React, and Express.js.
 
-## Why Choose Intlayer?
+The **`intlayer-cli`** package is a NPM package that consume the `@intlayer/cli` package and make it available to the `intlayer` commands line interfaces.
 
-- **JavaScript-Powered Content Management**: Harness the flexibility of JavaScript to define and manage your content efficiently.
-- **Type-Safe Environment**: Leverage TypeScript to ensure all your content definitions are precise and error-free.
-- **Integrated Content Files**: Keep your translations close to their respective components, enhancing maintainability and clarity.
-- **Simplified Setup**: Get up and running quickly with minimal configuration, especially optimized for Next.js projects.
-- **Server Component Support**: Perfectly suited for Next.js server components, ensuring smooth server-side rendering.
-- **Enhanced Routing**: Full support for Next.js app routing, adapting seamlessly to complex application structures.
+> Note that this package is not needed if the [`intlayer`](https://github.com/aymericzip/intlayer/tree/main/docs/en/packages/intlayer/index.md) package is installed. In comparison to the `intlayer` package, the `intlayer-cli` package is a lighter package that only contains the CLI tool, without `@intlayer/core` dependencies.
 
-### Install Package
+## Installation
 
-Install the necessary packages using npm:
+Install the necessary package using your preferred package manager:
 
-```bash
+```bash packageManager="npm"
 npm install intlayer-cli
 ```
 
-```bash
-yarn add intlayer-cli
-```
-
-```bash
+```bash packageManager="pnpm"
 pnpm add intlayer-cli
 ```
 
-## intlayer-cli package
-
-`intlayer-cli` package intend to transpile your [intlayer](https://github.com/aymericzip/intlayer/blob/main/packages/intlayer/README.md) declarations into dictionaries.
-
-This package will transpile all intlayer files, such as `src/**/*.content.{ts|js|mjs|cjs|json}`. [See how to declare your Intlayer declaration files](https://github.com/aymericzip/intlayer/blob/main/packages/intlayer/README.md)
-
-To interpret intlayer dictionaries you can interpreters, such as [react-intlayer](https://github.com/aymericzip/intlayer/blob/main/packages/react-intlayer/README.md) [next-intlayer](https://github.com/aymericzip/intlayer/blob/main/packages/next-intlayer/README.md)
-
-## Configuration File Support
-
-Intlayer accepts multiple configuration file formats:
-
-- `intlayer.config.ts`
-- `intlayer.config.js`
-- `intlayer.config.json`
-- `intlayer.config.cjs`
-- `intlayer.config.mjs`
-- `.intlayerrc`
-
-To see how to configure available locales, or other parameters, refer to the [configuration documentation here](https://github.com/aymericzip/intlayer/blob/main/docs/en/configuration.md)
+```bash packageManager="yarn"
+yarn add intlayer-cli
+```
 
-### Run intlayer commands
+## Usage
 
-To build your dictionaries, you can run the commands:
+Here an example of how to use the `intlayer-cli` package:
 
 ```bash
 npx intlayer build
 ```
 
-or in watch mode
+## CLI commands
 
-```bash
-npx intlayer build --watch
-```
+Intlayer provides a CLI tool to:
 
-### Use intlayer commands in your `package.json`
+- audit your content declarations and complete missing translations
+- build dictionaries from your content declarations
+- push and pull distant dictionaries from your CMS to your locale project
 
-```json
-"scripts": {
-  "transpile": "npx intlayer build",
-  "transpile:watch": "npx intlayer build --watch"
-}
-```
+Consult [intlayer-cli](https://github.com/aymericzip/intlayer/blob/main/docs/en/intlayer_cli.md) for more information.
+
+## Read about Intlayer
+
+- [Intlayer Website](https://intlayer.org)
+- [Intlayer Documentation](https://intlayer.org/docs)
+- [Intlayer GitHub](https://github.com/aymericzip/intlayer)
+
+- [Ask your questions to our smart documentation](https://intlayer.org/docs/chat)

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "intlayer-cli",
-  "version": "4.0.0",
+  "version": "4.0.3",
   "private": false,
-  "description": "IntLayer is a layer of abstraction between the business logic and the data access layer. Manage internationalization in a simple way, through TypeScript, JavaScript or JSON declaration file.",
+  "description": "Lightweight CLI tool for Intlayer, enabling content audits, dictionary management, and CMS sync. Ideal for JavaScript developers using React or Express.",
   "keywords": [
     "intlayer",
     "application",
@@ -59,7 +59,7 @@
   ],
   "dependencies": {
     "webpack": "^5.97.1",
-    "@intlayer/cli": "4.0.0"
+    "@intlayer/cli": "4.0.3"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.5.0",
@@ -75,8 +75,8 @@
     "typescript": "^5.7.3",
     "@utils/eslint-config": "1.0.4",
     "@utils/ts-config": "1.0.4",
-    "@utils/ts-config-types": "1.0.4",
-    "@utils/tsup-config": "1.0.4"
+    "@utils/tsup-config": "1.0.4",
+    "@utils/ts-config-types": "1.0.4"
   },
   "engines": {
     "node": ">=14.18"