bharatr21 commented 5 years ago

First off, thanks for the amazing project!

Few things which I had trouble from the README which could benefit many users:

Remove the $ from the bash commands to make it copy-pastable for users
Mention Quickstart Guide

codecov-io commented 5 years ago

Codecov Report

Merging #340 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #340   +/-   ##
=======================================
  Coverage   87.64%   87.64%           
=======================================
  Files          13       13           
  Lines        1505     1505           
  Branches      348      348           
=======================================
  Hits         1319     1319           
  Misses        129      129           
  Partials       57       57

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update de97be2...2f2275b. Read the comment docs.

vinayak-mehta commented 5 years ago

The $ acts as a hint on where to run those commands, which are not very long. How does the '```bash' help here?

bharatr21 commented 5 years ago

@vinayak-mehta as mentioned above, removing the $ makes it easily copy-pastable for users in a bash shell and the '``bash' helps in syntax highlighting bash-specific commands such ascd`, if any

atlanhq / camelot

[MRG] Update README and fix <pre>...</pre> rendering #340

Codecov Report