Skip to content

Commit cbebd8f

Browse files
committed
Added TOC and downloads button to readme.
1 parent 4b8f7ee commit cbebd8f

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

+30-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Mapper
22
======
33

44
[![Latest version][Version image]][Releases]
5+
[![Total downloads][Downloads image]][Downloads]
56
[![Build status][Build image]][Build]
67
[![Test coverage][Coverage image]][Coverage]
78
[![Code style][Style image]][Style]
@@ -14,6 +15,32 @@ $mappedData = (new Mapper)->map($data, new MyMapping);
1415

1516
This supposes we already created a mapping, `MyMapping`, to convert `$data` into `$mappedData`.
1617

18+
Contents
19+
--------
20+
21+
1. [Mappings](#mappings)
22+
2. [Strategies](#strategies)
23+
3. [Practical example](#practical-example)
24+
4. [Strategy reference](#strategy-reference)
25+
1. [Copy](#copy)
26+
2. [CopyContext](#copycontext)
27+
3. [Callback](#callback)
28+
4. [Collection](#collection)
29+
5. [Context](#context)
30+
6. [Either](#either)
31+
7. [Filter](#filter)
32+
8. [Flatten](#flatten)
33+
9. [IfExists](#ifexists)
34+
10. [Merge](#merge)
35+
11. [TakeFirst](#takefirst)
36+
12. [ToList](#tolist)
37+
13. [Type](#type)
38+
14. [Unique](#unique)
39+
15. [Walk](#walk)
40+
5. [Requirements](#requirements)
41+
6. [Limitations](#limitations)
42+
7. [Testing](#testing)
43+
1744
Mappings
1845
--------
1946

@@ -718,8 +745,10 @@ in this document can be found in `DocumentationTest`.
718745

719746
[Releases]: https://github.com/ScriptFUSION/Mapper/releases
720747
[Version image]: https://poser.pugx.org/scriptfusion/mapper/version "Latest version"
748+
[Downloads]: https://packagist.org/packages/scriptfusion/mapper
749+
[Downloads image]: https://poser.pugx.org/scriptfusion/mapper/downloads "Total downloads"
721750
[Build]: http://travis-ci.org/ScriptFUSION/Mapper
722-
[Build image]: https://travis-ci.org/ScriptFUSION/Mapper.svg "Build status"
751+
[Build image]: https://travis-ci.org/ScriptFUSION/Mapper.svg?branch=master "Build status"
723752
[Coverage]: https://coveralls.io/github/ScriptFUSION/Mapper
724753
[Coverage image]: https://coveralls.io/repos/ScriptFUSION/Mapper/badge.svg "Test coverage"
725754
[Style]: https://styleci.io/repos/59734709

0 commit comments

Comments
 (0)