Update README.md (#31)

Author: Philipp Spiess

README.md

@@ -1,4 +1,5 @@
 <!-- Plugin description -->
+
 # Sourcegraph for JetBrains IDEs [![JetBrains Plugin](https://img.shields.io/badge/JetBrains-Sourcegraph-green.svg)](https://plugins.jetbrains.com/plugin/9682-sourcegraph)
 
 - Search snippets of code on Sourcegraph.
@@ -69,52 +70,18 @@ Please file an issue: https://github.com/sourcegraph/sourcegraph-jetbrains/issue
 
 - Start IntelliJ and choose `Check out from Version Control` -> `Git` -> `https://github.com/sourcegraph/sourcegraph-jetbrains`
 - Develop as you would normally (hit Debug icon in top right of IntelliJ) or using gradlew commands:
-  1. `./gradlew runIde` to run an IDE instance with sourcegraph plugin installed
+  1. `./gradlew runIde` to run an IDE instance with sourcegraph plugin installed. This will start the platform with the versions defined in [`gradle.properties`](https://github.com/sourcegraph/sourcegraph-jetbrains/blob/main/gradle.properties#L14-L16). _Note: 2021.3 is required for M1 Macs._
   2. `./gradlew buildPlugin` to build plugin artifact (`build/distributions/Sourcegraph.zip`)
-- To create `sourcegraph.jar`:
-  1. Update `plugin.xml` (change version AND describe changes in change notes).
-  2. Update `Util.java` (change `VERSION` constant).
-  3. Update `README.md` (copy changelog from plugin.xml).
-  4. choose `Build` -> `Prepare Plugin Module 'sourcegraph' For Deployment`
-  5. `git commit -m "all: release v<THE VERSION>"` and `git push` and `git tag v<THE VERSION>` and `git push --tags`
-  6. Upload the jar to the releases tab of this repository.
-  7. Publish according to http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/publishing_plugin.html (note: it takes ~2 business days for JetBrains support team to review the plugin).
-
-## Version History
-
-#### v1.2.2
-
-- It is now possible to configure the plugin per-repository using a `.idea/sourcegraph.xml` file. See the README for details.
-    - Special thanks: @oliviernotteghem for contributing the new features in this release!
-- Fixed bugs where Open in Sourcegraph from the git menu does not work for repos with ssh url as their remote url
-
-#### v1.2.1
-
-- Added `Open In Sourcegraph` action to VCS History and Git Log to open a revision in the Sourcegraph diff view.
-- Added `defaultBranch` configuration option that allows opening files in a specific branch on Sourcegraph.
-- Added `remoteUrlReplacements` configuration option that allow users to replace specified values in the remote url with new strings.
 
-#### v1.2.0
+## Publishing a new version
 
-- The search menu entry is now no longer present when no text has been selected.
-- When on a branch that does not exist remotely, `master` will now be used instead.
-- Menu entries (Open file, etc.) are now under a Sourcegraph sub-menu.
-- Added a "Copy link to file" action (alt+c / opt+c).
-- Added a "Search in repository" action (alt+r / opt+r).
+The publishing process is based on the actions outlined in the [`intellij-platform-plugin-template`](https://github.com/JetBrains/intellij-platform-plugin-template).
 
-#### v1.1.2
+1. Create a [new release](https://github.com/sourcegraph/sourcegraph-jetbrains/releases/new) on GitHub.
+2. Pick the new version number as the git tag (e.g. `v1.2.3`).
+3. Copy/paste the `[Unreleased]` section of the [`CHANGELOG.md`](https://github.com/sourcegraph/sourcegraph-jetbrains/blob/main/CHANGELOG.md) into the GitHub release text.
+4. Once published, a GitHub action is triggered that will publish the release automatically and create a PR to update the changelog and version text.
 
-- Fixed an error that occurred when trying to search with no selection.
-- The git remote used for repository detection is now `sourcegraph` and then `origin`, instead of the previously poor choice of just the first git remote.
-
-#### v1.1.1
-
-- Fixed search shortcut; Updated the search URL to reflect a recent Sourcegraph.com change.
-
-#### v1.1.0
-
-- Added support for using the plugin with on-premises Sourcegraph instances.
-
-#### v1.0.0
+## Version History
 
-- Initial Release; basic Open File & Search functionality.
+See [`CHANGELOG.md`](https://github.com/sourcegraph/sourcegraph-jetbrains/blob/main/CHANGELOG.md).