diff --git a/README.md b/README.md index 21cfe43..b75fb32 100755 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ -# Contentstack import utility +# Deprecation Warning + +The import 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 import 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. -This tool helps you to import content which is exported using [contentstack-export](https://github.com/contentstack/contentstack-export) utility into another stack. +This tool helps you to import content which is exported using [contentstack-export](https://github.com/contentstack/contentstack-export) utility into another stack. ## Installation + Download this project and install all the modules using following command. ```bash @@ -12,6 +17,7 @@ $ npm install ``` ## Configuration + Update configuration details at config/index.js ```js @@ -26,6 +32,7 @@ Update configuration details at config/index.js management_token: '' //Stack management_token data: '' // The data that's to be exported. This is generally the one exported via the contentstack-export utility. ex: '../contentstack-export/contents'. Kindly provide the relative path to the directory ``` + For switching to EU region update the hosts at config/default.js ```js @@ -33,16 +40,20 @@ For switching to EU region update the hosts at config/default.js host:'https://eu-api.contentstack.com/v3', ... } -``` +``` + ## Usage + Once all things are configured, you can run following commands 1. Import all modules [ assets, locales, environments, extensions, webhooks, global_fields, content_types, entries, labels ] + ```bash $ npm run import ``` 2. Import a specific module + ```bash $ npm run import-locales $ npm run import-env @@ -55,18 +66,21 @@ $ npm run import-entries $ npm run import-labels ``` + > Note: Before importing entries you must have to import 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 -* It will migrate only latest published version of entry. -* Does not support the following - * Roles - * Users - * Releases - * Workflow -* If 2 different versions of the same asset have the same file name, only the 1st version will be imported + +- It will migrate only latest published version of entry. +- Does not support the following + - Roles + - Users + - Releases + - Workflow +- If 2 different versions of the same asset have the same file name, only the 1st version will be imported ## License + This project is licensed under MIT license