search

alexedwards / scs

HTTP Session Management for Go
MIT License
2.02k stars 165 forks source link

docs: Enhance Markdown formatting in README #178

Closed Daniel-Sogbey closed 8 months ago

Daniel-Sogbey commented 9 months ago

Improve the formatting of the code block in the README by escaping the $ character. This ensures that when users copy the code, the $ sign is not included.

alexedwards commented 8 months ago

As far as I can see, this breaks the formatting of the code block when viewing the README on GitHub (which I think is where it will most commonly be read). See the screenshot below:

image

dropwhile commented 8 months ago

@alexedwards I assume they meant do it like this:

```sh
go get github.com/alexedwards/scs/v2


Basically just leaving off the `$` so it is easier for folks to just copy and paste.
Daniel-Sogbey commented 8 months ago

Hello @alexedwards new push made

alexedwards commented 8 months ago

@Daniel-Sogbey Great, thanks! Merging now...

Daniel-Sogbey commented 8 months ago

Thanks for the opportunity to contribute ❤️