Comprehensive edit of README.md - Githubissues

ring-clojure / ring-defaults

A library to provide sensible Ring middleware defaults

MIT License

345 stars 32 forks source link

Comprehensive edit of README.md #31

Closed goodgerster closed 4 years ago

goodgerster commented 4 years ago

Removes hard wrapping
Makes headings’ case consistent
Condenses, clarifies and harmonizes phrasing
Adds usage examples for configuration options with non-Boolean choices
Corrects and harmonizes punctuation
Adds dependency instruction for Clojure Deps
Marks up in-sentence Clojure values, HTTP values, etc.
Replaces hyphens with asterisks in unordered lists, as they also contain dashes
Expands link text to aid accessibility
Adds new links
Switches code fences to ‘interrupt’ paragraphs rather than be paragraphs

weavejester commented 4 years ago

It's very hard to review this when there are so many changes packed together. Some of them are good; others not so much. I don't currently have the time to go through all the changes line by line, but most of the stylistic/formatting changes can be removed. In general, if a file is written with particular formatting, it's generally a good idea to keep to that formatting when making changes.