T-73: README sections comments

README.md

@@ -1,19 +1,23 @@
+<!-- Header -->
 <h1 align="center">
   Basic Temperature
 </h1>
 
+<!-- Badges -->
 [![Gem Version](https://badge.fury.io/rb/basic_temperature.svg)](https://rubygems.org/gems/basic_temperature) [![Build Status](https://travis-ci.com/marian13/basic_temperature.svg?branch=master)](https://travis-ci.com/marian13/basic_temperature) [![Maintainability](https://api.codeclimate.com/v1/badges/21dc5d50cf5de8346a3c/maintainability)](https://codeclimate.com/github/marian13/basic_temperature/maintainability) [![Coverage Status](https://coveralls.io/repos/github/marian13/basic_temperature/badge.svg)](https://coveralls.io/github/marian13/basic_temperature) [![Inline docs](http://inch-ci.org/github/marian13/basic_temperature.svg?branch=master)](http://inch-ci.org/github/marian13/basic_temperature)
 [![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/user?u=31435716&fan_landing=true)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
+<!-- Logo -->
 <p align="center">
   <img src="https://raw.githubusercontent.com/marian13/basic_temperature/master/logo.png">
 </p>
 
+<!-- General description -->
 `basic_temperature` is a Ruby library which provides a simple [value object](https://martinfowler.com/bliki/ValueObject.html) to work with temperatures and 
 allows to perform basic operations like conversion from Celsius to Kelvin, from Kelvin to Fahrenheit etc.
 
-
+<!-- Features -->
 ### Features
 - Provides a `Temperature` class which encapsulates all information about a certain  temperature, such
 as its amount of degrees and its scale.
@@ -26,14 +30,17 @@ Rankine).
 [.travis-ci.yml](https://github.com/marian13/basic_temperature/blob/9b13cb9909b57c51bb5dc05a8989d07a314e67d6/.travis.yml)
 for the exact versions.
 
+<!-- Dependecies -->
 ### Dependecies
 
 * None.
 
+<!-- Documentation -->
 ### Documentation
 
 * Visit https://marian13.github.io/basic_temperature/ to view the documentation.
 
+<!-- Installation -->
 ## Installation
 
 Gemfile:
@@ -64,6 +71,7 @@ The following guide assumes you have chosen the shorter form.
 
 If not, just replace all `Temperature` to `BasicTemperature::Temperature`.
 
+<!-- Usage -->
 ## Usage
 
 ### Creating Temperatures
@@ -212,13 +220,16 @@ Temperature[0, :celsius].freeze_water?
 # => true
 ```
 
+<!-- Versioning -->
 ## Versioning
 Basic Temperature follows the [Semantic Versioning](https://semver.org/) standard.
 
+<!-- Contributing -->
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/marian13/basic_temperature.
 
+<!-- Development on the local machine -->
 ## Development on the local machine
 
 * Check specs: `bundle exec rspec`.
@@ -227,6 +238,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/marian
 
 * Update docs: `bundle exec sdoc lib -T rails -o docs`.
 
+<!-- Development with Docker -->
 ## Development with Docker
 
 * Build container: `docker build . -f docker/Dockerfile-2.3 -t basic_temperature_2.3`.
@@ -237,8 +249,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/marian
 
 * 2.3 can be replaced by 2.4, 2.5, 2.6, 2.7 and 3.0.
 
+<!-- License -->
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+<!-- Author -->
 Copyright (c) 2020 [Marian Kostyk](http://mariankostyk.com).