diff --git a/README.md b/README.md index 2d26fbe..7673066 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# Contentstack Export Utility +# Deprecation Warning + +The export utility has been deprecated. We will soon stop supporting this utility. We recommend you to use [Contentstack CLI](https://github.com/contentstack/cli) instead. + +## Contentstack Export Utility Contentstack is a headless CMS with an API-first approach that puts content at the centre. It is designed to simplify the process of publication by separating code from content. @@ -31,6 +35,7 @@ Update configuration details at config/index.js ... } ``` + For switching to EU region update the hosts at config/default.js ```js @@ -39,8 +44,10 @@ For switching to EU region update the hosts at config/default.js cdn: 'https://eu-cdn.contentstack.com/v3', ... } -``` +``` + ## Usage + After setting the configuration, you'll can run the below given commands! 1. Export all modules [ assets, locales, environments, extensions, webhooks, global_fields, content_types and entries, labels ] @@ -48,8 +55,9 @@ After setting the configuration, you'll can run the below given commands! ```bash $ npm run export ``` - + 2. Export a specific module + ```bash $ npm run export-assets $ npm run export-env @@ -62,17 +70,20 @@ $ npm run export-entries $ npm run export-labels ``` + > Note: Before exporting entries, you must export locales, assets and content types. > Note: If you keep the value of preserveStackVersion to true, then you will have to provide the email and password mandatorily in the config file, the management token will not work in that case. ### Known Limitations and Issues -* If 2 assets share same uid and filename, only the first version of the asset would be available -* Does not support the following - * Roles - * Users - * Releases - * Workflow + +- If 2 assets share same uid and filename, only the first version of the asset would be available +- Does not support the following + - Roles + - Users + - Releases + - Workflow ## License + This project is licensed under MIT license