diff --git a/README.md b/README.md index 70e66db..a422662 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,14 @@ The RTE plugin has the following configuration available. The values should be s - `baseUrl`: The base url for Contentstack, most likely `https://eu-app.contentstack.com/` - `formatId`: The id for the format in ImageVault to use when selecting an asset in ImageVault - `imageVaultUrl`: The URL to the ImageVault instance to use when selecting an asset. + +## Getting started + +Run `npm install` in the root and the [rte](rte), [remix](remix) folders to install all dependencies. After that you can start the project by running `npm run dev` in the root of the repository. + +To use the local version of ImageVault inside contentstack, you need to add the `Dev ImageVault Custom field` as custom extension instead of the default `ImageVault` extension. + +### Possible issues + +- Browsers/Browser extensions + - ContentStack is using the extension from your locally served extension through `localhost:3000`. This means that some browsers or browser extensions block ContentStack from talking with `localhost`. Solution: Disable this functionality in your browser.