postalsys / imapflow

IMAP Client library for EmailEngine Email API (https://emailengine.app)
https://imapflow.com
Other
350 stars 59 forks source link

Remove a dollar sign before the npm install command in README.md #187

Closed jvmusin closed 5 months ago

jvmusin commented 5 months ago

Problem

TLDR: Blind copy-pasting the $ npm install imapflow command doesn't work because of the leading dollar sign.

When reading the README.md on the main GitHub repository page, they provide a button to copy the content of the code block.

My workflow is to click this button and then paste the result elsewhere - in this case to the terminal.

Since the code block contains a dollar sign in the beginning, I can't just copy and paste the command. Instead, I will get an error command not found: $.

Solution

Remove the dollar sign from the beginning of $ npm install imapflow. This way, copy-pasting will work as expected.

The only possible downside is that it might decrease readability a bit, but nothing serious.

CLAassistant commented 5 months ago

CLA assistant check
All committers have signed the CLA.