Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md: update usage #591

Merged
merged 2 commits into from
May 21, 2020
Merged

README.md: update usage #591

merged 2 commits into from
May 21, 2020

Conversation

matyasforian
Copy link
Contributor

Mention that the extension only works if the file has .http extension. This was not clear for me when I installed it, needed to figure out from the screenshots.

mention that the extension only works if the file has .http extension. This was not clear for me when I installed it, needed to figure out from the screenshots.
README.md Outdated
@@ -57,7 +57,7 @@ REST Client allows you to send HTTP request and view the response in Visual Stud
- Fold/Unfold for request block

## Usage
In editor, type an HTTP request as simple as below:
In the editor create a new file, save it with `.http` extension, then type an HTTP request such as:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not quite accurate, actually, you don't need to type the request in a file with .http extension, just a file of HTTP language mode is enough. Even in a plain text file, you can still send HTTP request with Keyboard shortcuts.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This usage section continues with "Once you prepared a request, click the Send Request link above the request". This only appears if the extension of the file is .http* by default.

I am suggesting this addition because when I used your extension for the first time it took me like 15 mins to figure out why the send request button was not showing up. This part is the most important for first-time users, it should contain some super simple instructions how to get things working IMO.
I updated the text, maybe its more accurate now.

Even in a plain text file, you can still send HTTP request with Keyboard shortcuts.

I tried the Ctrl+Alt+R shortcut in a .css and in a .js file, it did nothing. It worked in a .http and .txt file.

Copy link
Owner

@Huachao Huachao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Huachao Huachao merged commit 7b5ff0d into Huachao:master May 21, 2020
@Huachao
Copy link
Owner

Huachao commented May 21, 2020

@matyasforian Merged, thanks 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants