@sanity/document-internationalization 0.3.1 → 1.0.0-v3-studio.2

package/README.md

@@ -1,5 +1,11 @@
 # Document Internationalization Plugin for Sanity.io
 
+> **NOTE**
+>
+> This is the **Sanity Studio v3 version** of sanity-plugin-latex-input.
+>
+> For the v2 version, please refer to the [v2-branch](https://github.com/sanity-io/latex-input).
+
 [![npm version](https://img.shields.io/npm/v/@sanity/document-internationalization.svg?style=flat)](https://www.npmjs.com/package/@sanity/document-internationalization)
 
 ![Document Level Internationalization UI](docs/img/document-level-translation.gif)
@@ -27,27 +33,40 @@ This plugin adds features to the Studio to improve handling **document-level tra
 
 For **field-level translations** you should use the [@sanity/language-filter plugin](https://www.npmjs.com/package/@sanity/language-filter).
 
+*Studio V3 note*: language-filter is not available for V3 yet.
+
 ### Many projects use both!
 
+*Studio V3 note*: language-filter is not available for V3 yet.
+
 An example of document-level translation could be a `lesson` schema, the `title`, `slug` and `content` fields would be unique in every language.
 
 A good use of field-level translation could be a `person` schema. It could have the same `name` and `image` in every language, but only the `biography` would need translating.
 
+## Studio V3 known issues
+
+Studio V3 does not implement language-filter yet. This means that the language button has moved into the document editor flow for the time being.
+We will be looking to restore the button placement during Studio V3 dev-preview. 
+
 ## Installation
 
-With the [Sanity CLI installed](https://www.sanity.io/docs/getting-started-with-sanity-cli), from the same directory as the Studio run:
+From the same directory as the Studio run:
 
+```sh
+npm install --save @sanity/document-internationalization@studio-v3
 ```
-sanity install @sanity/document-internationalization
+
+or
+
+```sh
+yarn add @sanity/document-internationalization@studio-v3
 ```
 
-Ensure that `@sanity/document-internationalization` is listed in `plugins` inside `sanity.json`.
 
 The plugin is now installed, but you will need to complete the following steps to see the Document Translation UI:
 
 ## Setup next steps
-
-1. [Configuration options](docs/configuration-options.md)  
+1. [Enabling and configuring the plugin](docs/enabling-and-configuring.md)  
    To declare available Languages and other settings
 2. [Activating internationalization on schema](docs/activating-internationalization-on-schema.md)  
    To enable all the above features on schema
@@ -62,7 +81,8 @@ The plugin is now installed, but you will need to complete the following steps t
 4. [GraphQL support](docs/graphql-intl-doc.md)
 5. [Advanced languages](docs/advanced-languages.md)
 6. [Usage with custom publish action](docs/usage-with-custom-publish.md)
-7. [GROQ query examples](/docs/groq-query-examples.md)
+7. [If you don't see the plugin document actions](docs/usage-with-custom-publish.md#add-additional-actions)
+8. [GROQ query examples](/docs/groq-query-examples.md)
 
 ## Migrating from sanity-plugin-intl-input