From 876fd7ac3096e98e0d7084190b4525b5c3d4b4dd Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Mon, 25 Sep 2023 11:58:42 +0300 Subject: [PATCH] Update README.md --- jetbrains-gateway/README.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/jetbrains-gateway/README.md b/jetbrains-gateway/README.md index 86a9acc..7224023 100644 --- a/jetbrains-gateway/README.md +++ b/jetbrains-gateway/README.md @@ -4,30 +4,42 @@ description: Add a one-click button to launch JetBrains Gateway IDEs in the dash icon: ../.icons/gateway.svg maintainer_github: coder verified: true -tags: [ide, jetbrains, gateway, goland, webstorm, intellij, pycharm, phpstorm, clion, rubymine, datagrip, rider] +tags: [ide, jetbrains, helper] --- # JetBrains Gateway -This module adds a JetBrains Gateway IDEs to your Coder template. +This module adds a JetBrains Gateway Button to open any workspace with a single click. -## How to use this module +## Examples -To use this module, add the following snippet to your template manifest: +### Add GoLand and WebStorm with the default set to GoLand ```hcl module "jetbrains_gateway" { source = "https://registry.coder.com/modules/jetbrains-gateway" - agent_id = coder_agent.main.id - agent_name = "main" - project_directory = "/home/coder/project" - jetbrains_ides = ["GO","WS"] + agent_id = coder_agent.example.id + agent_name = "example" + project_directory = "/home/coder/example" + jetbrains_ides = ["GO", "WS"] default = "GO" } ``` +### Add CLion and Idea with no D=deafult + +```hcl +module "jetbrains_gateway" { + source = "https://registry.coder.com/modules/jetbrains-gateway" + agent_id = coder_agent.example.id + agent_name = "example" + project_directory = "/home/coder/example" + jetbrains_ides = ["IU", "CL"] +} +``` + ## Supported IDEs -The following JetBrains IDEs are supported: +This module and JetBrains Gateway support the following JetBrains IDEs: - GoLand (`GO`) - WebStorm (`WS`)