diff --git a/projector-plugin/README.md b/projector-plugin/README.md index 1c0e521c..cb6463ab 100644 --- a/projector-plugin/README.md +++ b/projector-plugin/README.md @@ -1,4 +1,5 @@ # projector-plugin + This subproject is an IntelliJ plugin for sharing the IDE window using the Projector server. Please note that it's an experimental technology. @@ -6,6 +7,15 @@ Please note that it's an experimental technology. If you want simultaneous collaborative editing, please try [Code With Me](https://www.jetbrains.com/help/idea/code-with-me.html) solution. Projector doesn't support that. +## Downloading from Plugins Marketplace + +The plugin is published here: . So you can find it in IDE and install it (manual IDE +restart is needed after installation). + +## Usage + +New menu item `Projector` will appear next to the `Help` in the title bar. + ## Building from sources This will give you a zip file with IntelliJ plugin: @@ -16,12 +26,11 @@ This will give you a zip file with IntelliJ plugin: This command creates a zip file in the `projector-plugin/build/distributions` dir. -## Downloading +## Downloading zip file from releases Alternatively, you can download the zip file from [releases](https://github.com/JetBrains/projector-server/releases/). Please search for the latest release starting with `agent-...` and find the plugin in Assets there. -## Usage +## Installing zip file -Install the plugin (the zip file) into IntelliJ IDEA via `Gear Icon | Install plugin from disk...` menu item in Plugins settings. New menu -item `Projector` will appear next to the `Help` in the title bar. +Install the plugin (the zip file) into IntelliJ-based IDE via `Gear Icon | Install plugin from disk...` menu item in Plugins settings.