diff --git a/README.md b/README.md index e48ab93..2502fa6 100644 --- a/README.md +++ b/README.md @@ -89,11 +89,11 @@ pnpm run coverage To debug the CLI you can use the `launch.json` configuration in the `.vscode` folder. You can run any command with the debugger attached. -![Debugging](/.github/assets/debug-vscode.png) +![A screenshot of the Visual Studio Code debugger](/.github/assets/debug-vscode.png) Then you can set breakpoints directly to the typescript files and the debugger will handle the rest with sourcempaps. -![Debugging](/.github/assets/breakpoints.png) +![A screenshot of a breakpoint set in the Visual Studio Code debugger](/.github/assets/breakpoints.png) ## Community @@ -107,7 +107,7 @@ For community support, chatting with other users, please visit: ## Support -For bugs or feature requests, please [submit an issue](https://github.com/storyblok/my-joyful-package/issues/new/choose). +For bugs or feature requests, please [submit an issue](https://github.com/storyblok/storyblok-cli/issues/new/choose). > [!IMPORTANT] > Please search existing issues before submitting a new one. Issues without a minimal reproducible example will be closed. [Why reproductions are Required](https://antfu.me/posts/why-reproductions-are-required). @@ -122,7 +122,7 @@ If you have a question, please ask in the [Discuss Storyblok on Discord](https:/ ## Contributing -If you're interested in contributing to my-joyful-package, please read our [contributing docs](https://github.com/storyblok/.github/blob/main/CONTRIBUTING.md) before submitting a pull request. +If you're interested in contributing to Storyblok CLI, please read our [contributing docs](https://github.com/storyblok/.github/blob/main/contributing.md) before submitting a pull request. ## License diff --git a/src/README.md b/src/README.md index 5e5dc36..4355898 100644 --- a/src/README.md +++ b/src/README.md @@ -31,7 +31,7 @@ npm install storyblok@4.0.0-beta. | [`migrations run`](./commands/migrations/run/README.md) | ✅ | Replaces previous run-migrations | | [`migrations rollback`](./commands/migrations/rollback/README.md) | ✅ | Replaces previous rollback-migrations | | [`types generate`](./commands/types/generate/README.md) | ✅ | Replaces previous generate-typescript-typedefs | -| `sync` | ⚠️ | | +| `sync` | ⚠️ | Pending new API endpoint implementation for improved performance and reliability (Check below for more details) | | `datasources pull` | 📝 | | | `datasources push` | 📝 | | | `datasources delete` | 📝 | Will replace delete-datasources | @@ -43,9 +43,19 @@ npm install storyblok@4.0.0-beta. ### Status Legend - ✅ Ready: Feature is implemented and ready to use - 📝 Planned: Feature is planned for future implementation -- ⚠️ v3: Feature is available only in v3 +- ⚠️ v3: Feature is available only in [v3](https://github.com/storyblok/storyblok-cli/tree/v3) - 💬 TBD: Feature is under discussion +## Sync Command + +> [!IMPORTANT] +> The sync command is being reimagined as a new API endpoint that will perform synchronization between spaces. This new implementation will provide: +> - Faster synchronization compared to the current CLI version +> - Improved reliability by running on our backend servers +> - Better handling of large-scale synchronization operations + +If you wish to continue using the `sync` command, please refer to the [v3](https://github.com/storyblok/storyblok-cli/tree/v3?tab=readme-ov-file#sync) documentation and use `storyblok@v3.36.1` or previous. + ## Global Options These options are available for all commands: