sanity-plugin-mux-input 1.1.6 → 1.2.0-main.2

package/README.md

@@ -1,6 +1,12 @@
 # Mux Video Input Sanity Plugin
 
-This is a plugin which let you use [Mux](https://www.mux.com) video assets in your Sanity studio.
+> **NOTE**
+>
+> This is the **Sanity Studio v3 version** of sanity-plugin-mux-input.
+>
+> For the v2 version, please refer to the [studio-v2 branch](https://github.com/sanity-io/sanity-plugin-mux-input).
+
+This is a plugin that let you use [Mux](https://www.mux.com) video assets in your Sanity studio.
 
 The Mux plugin for Sanity gives you a way to upload and preview videos easily.
 
@@ -10,8 +16,8 @@ Not familiar with Sanity? [Visit www.sanity.io](https://www.sanity.io/)
 
 ## Quick start
 
-- While in your project folder, run `sanity install mux-input`.
-  Read more about [using plugins in Sanity here](https://www.sanity.io/docs/plugins).
+- While in your project folder, run `npm i sanity-plugin-mux-input`.
+  Read more about [using plugins in Sanity here](https://beta.sanity.io/docs/platform/studio/plugin).
 
 * Make a schema type that uses the plugin's type `mux.video`, for example:
 
@@ -43,11 +49,11 @@ Not familiar with Sanity? [Visit www.sanity.io](https://www.sanity.io/)
   The token is stored in the dataset as a document of the type `mux.apiKey` with the id `secrets.mux`.
   Having the ID be non-root ensures that only editors are able to see it.
 
-  The Mux plugin will find it’s access tokens by fetching this document.
+  The Mux plugin will find its access tokens by fetching this document.
 
 # Playing videos in the frontend
 
-We have made an own player which supports poster images for the videos as set with this plugin, see [`sanity-mux-player`](https://github.com/sanity-io/sanity-mux-player)
+We have made our own player which supports poster images for the videos as set with this plugin, see [`sanity-mux-player`](https://github.com/sanity-io/sanity-mux-player)
 
 You could use any player which supports HLS, just point the video source to:
 
@@ -61,36 +67,52 @@ More information for this feature of the plugin can be found on Mux's [documenta
 
 # Enabling MP4 support
 
-To enable [static MP4 renditions](https://docs.mux.com/guides/video/enable-static-mp4-renditions), create or open the config file found in `config/mux-input.json` in your studio folder. This file is automatically created the first time the studio starts after adding the plugin.
+To enable [static MP4 renditions](https://docs.mux.com/guides/video/enable-static-mp4-renditions), add `mp4_support: 'standard'` to the `options` of your `mux.video` schema type.
+
+js```
+import {muxInput} from 'sanity-plugin-mux-input'
+
+export deafult createConfig({
+plugins: [muxInput({
+mp4_support: "standard"
+})]
+})
 
-```
-{
-  "mp4_support": "standard"
-}
 ```
 
-Currently `mp4_support` is the only supported MUX option and this supports a value of either `standard` or `none` (the default).
+Currently, `mp4_support` is the only supported MUX option and this supports a value of either `standard` or `none` (the default).
 
 # Contributing
 
 Issues are actively monitored and PRs are welcome. When developing this plugin the easiest setup is:
 
 1. Fork this repo.
-1. Install the sanity cli and create a sanity project: `npm install -g @sanity/cli && sanity init`. Follow the prompts, starting out with the blog template is a good way to go.
+1. Create a studio v3 project: `npm create sanity@dev-preview`. Follow the prompts, starting out with the blog template is a good way to go.
 1. `cd` into your project directory, run `npm install && npm start` - your sanity studio should be running on http://localhost:3333.
-1. `cd` into the `plugins` director of your project.
+1. `cd` into the `plugins` directory of your project.
 1. Fork this repo and clone your fork into the `plugins` directory inside your project `git clone git@github.com:your-fork/sanity-plugin-mux-input.git`.
 1. Open `sanity.json`, go to the `plugins` array and add `mux-input`.
 1. Re-start the sanity studio server with `npm start`.
 1. Edit `schemas/post.js` and add follow the plugin documentation to add a `mux.video` type field.
-1. Your studio should reload, and now when you edit the plugin code it should reload the studio, when you're done create a branch, put in a PR and a maintainer will review it. Thank you!
+1. Your studio should reload, and now when you edit the plugin code it should reload the studio, when you're done creating a branch, put in a PR and a maintainer will review it. Thank you!
+
+# Publishing
 
-## Publishing
+Publishing is done by pushing [Conventional Commits](https://github.com/semantic-release/semantic-release#how-does-it-work).
+On the [studio-v2](/tree/studio-v2) branch this will result in:
 
-### Test
+- a new version on the `latest` dist-tag.
+- running `yarn add sanity-plugin-mux-input` or `npm i sanity-plugin-mux-input` will fetch the new version.
+- running `sanity install mux-input` will fetch the new version.
+- studio-v3 users are unaffected.
+  On the [main](/tree/main) branch this will result in:
+- a new prerelease version on the `studio-v3` dist-tag.
+- running `yarn add sanity-plugin-mux-input@studio-v3` or `npm i sanity-plugin-mux-input@studio-v3` will fetch the new version.
+- running `sanity install mux-input` won't fetch the new version.
 
-`yarn semantic-release`
+After Studio v3 turns stable this behavior will change. The v2 version will then be available on the `studio-v2` dist-tag, and `studio-v3` is upgraded to live on `latest`.
 
-### Go live
+# Test
 
-`yarn semantic-release -- --no-ci`
+`npm test`
+```