anboralabs / intellij-ngrok

Ngrok plugin integration with intellij
https://plugins.jetbrains.com/plugin/19205-ngrok
GNU General Public License v3.0
6 stars 1 forks source link

docs: Add step-by-step instructions #3

Closed Swimburger closed 2 years ago

Swimburger commented 2 years ago

We're excited about this plugin but struggled to figure out how to use it. We eventually found that you have to create a run configuration, and once you do that, you can start the ngrok application, and then right-click on the application to create a tunnel under the services tab.

This isn't very discoverable however, so it'd be great if there was more documentation on how to use the plugin. I'd be happy to help in that regard.

dalgarins commented 2 years ago

@Swimburger thank you, you are right, which do you think is the best way to create a tutorial? where do you want to see it? in the plugin page? if you want to contribute please create the tutorial and I'll publish in the main page. what do you think?

Swimburger commented 2 years ago

The users should definitely be able to find instructions from the plugin page or directly in their IDE where they install the plugin. Depending on how much guidance is necessary, I'd put a summary on their + a link to a markdown file on GitHub. What do you think of that?

Swimburger commented 2 years ago

Is the most optimal path the following?

dalgarins commented 2 years ago

Thanks a lot, I will add this and I will also create a video to show how to use it. I'll let you know and ask you for feedback.

dalgarins commented 2 years ago

@Swimburger added a video an simple documentation for the plugin. thanks a lot.

Swimburger commented 2 years ago

Great! Where can we find this video?