search

kenhowardpdx / vscode-gist

vscode extension for quick gists
MIT License
177 stars 17 forks source link

README needs more information #123

Closed fayimora closed 3 years ago

fayimora commented 4 years ago

This is a

Description

Hi,

Can someone pls add a full sample for profileOptions to the readme?

The readme says

profileOptions gives you some debugging capabilities. You can provide a profile name along with key, url, and rejectUnauthorized values. Before you can use profileOptions you MUST have the profile created.

To be honest, I have no clue what this all means.

I think that statement comes with the expectation that you're a VSC sensei. All most people really want to know (myself inclusive) is what to add to their settings.json to get this all working but it's not so clear from the readme(I've asked 4 people to help already). It will be great if someone can add some "for dummies" details to the readme. 🤗

Thanks

kenhowardpdx commented 4 years ago

I understand. This was a work-around for some users wanting to set the profiles in the settings.json it shouldn't be used by regular users. I'll look at adding better documentation for this.

kenhowardpdx commented 3 years ago

Not updating README. The documentation holds up.