Merge pull request #7 from Nekland/doc/highlight-components

Update README to highlight components
Nekland · Apr 23, 2018 · 7a7bd70 · 7a7bd70
2 parents 0c6120e + 0c32fe3
commit 7a7bd70
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -17,6 +17,13 @@ composer require "nekland/tools"
 Reference
 ---------
 
+This library provide some tools to help you with your developments.
+
+Here is the list of tools it provides:
+- [StringTools](#stringtools-class)
+- [EqualableInterface](#equalableinterface)
+- [DateTimeComparator](#datetimecomparator-class)
+
 ### StringTools class
 
 **Encoding arguments are optionals.**
@@ -118,4 +125,4 @@ DateTimeComparator::lowest($dateTime1, $dateTime2) : ?\DateTimeInterface
 ```
 
 * `$dateTime1` The first \DateTimeInterface or null
-* `$dateTime2` The second \DateTimeInterface or null
+* `$dateTime2` The second \DateTimeInterface or null