Skip to content

Commit fa5ee92

Browse files
committed
Added documentation readme badge
1 parent 6677262 commit fa5ee92

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
<h1>Slim <img src="https://i.imgur.com/YzDYQ0V.png" width="60px" alt="API"> starter</h1>
44

5+
[![Documentation](https://img.shields.io/badge/Documentation-blue?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj4NCjwhLS0gVXBsb2FkZWQgdG86IFNWRyBSZXBvLCB3d3cuc3ZncmVwby5jb20sIFRyYW5zZm9ybWVkIGJ5OiBTVkcgUmVwbyBNaXhlciBUb29scyAtLT4KPHN2ZyB3aWR0aD0iODAwcHgiIGhlaWdodD0iODAwcHgiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KDTxnIGlkPSJTVkdSZXBvX2JnQ2FycmllciIgc3Ryb2tlLXdpZHRoPSIwIi8%2BCg08ZyBpZD0iU1ZHUmVwb190cmFjZXJDYXJyaWVyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz4KDTxnIGlkPSJTVkdSZXBvX2ljb25DYXJyaWVyIj4gPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik05Ljk0NTMxIDEuMjVIMTQuMDU1MUMxNS40MjI3IDEuMjQ5OTggMTYuNTI1IDEuMjQ5OTYgMTcuMzkxOSAxLjM2NjUyQzE4LjI5MiAxLjQ4NzU0IDE5LjA0OTkgMS43NDY0MyAxOS42NTE4IDIuMzQ4MzVDMjAuMjUzOCAyLjk1MDI3IDIwLjUxMjYgMy43MDgxNCAyMC42MzM3IDQuNjA4MjVDMjAuNzUwMiA1LjQ3NTIyIDIwLjc1MDIgNi41Nzc1NCAyMC43NTAyIDcuOTQ1MTNWMTYuMDU0OUMyMC43NTAyIDE3LjQyMjUgMjAuNzUwMiAxOC41MjQ4IDIwLjYzMzcgMTkuMzkxOEMyMC41MTI2IDIwLjI5MTkgMjAuMjUzOCAyMS4wNDk3IDE5LjY1MTggMjEuNjUxN0MxOS4wNDk5IDIyLjI1MzYgMTguMjkyIDIyLjUxMjUgMTcuMzkxOSAyMi42MzM1QzE2LjUyNSAyMi43NSAxNS40MjI2IDIyLjc1IDE0LjA1NTEgMjIuNzVIOS45NDUzMkM4LjU3NzczIDIyLjc1IDcuNDc1NCAyMi43NSA2LjYwODQ0IDIyLjYzMzVDNS43MDgzMyAyMi41MTI1IDQuOTUwNDUgMjIuMjUzNiA0LjM0ODU0IDIxLjY1MTdDMy43NDY2MiAyMS4wNDk3IDMuNDg3NzMgMjAuMjkxOSAzLjM2NjcxIDE5LjM5MThDMy4zMjgwMSAxOS4xMDM5IDMuMzAyMTYgMTguNzkwMiAzLjI4NDkgMTguNDQ5NEMzLjI0NTgyIDE4LjMyNiAzLjIzODIxIDE4LjE5MTIgMy4yNjg5NSAxOC4wNTY4QzMuMjUwMTYgMTcuNDY0OSAzLjI1MDE3IDE2Ljc5OTEgMy4yNTAxOSAxNi4wNTQ5VjcuOTQ1MTNDMy4yNTAxNyA2LjU3NzU0IDMuMjUwMTUgNS40NzUyMiAzLjM2NjcxIDQuNjA4MjVDMy40ODc3MyAzLjcwODE0IDMuNzQ2NjIgMi45NTAyNyA0LjM0ODU0IDIuMzQ4MzVDNC45NTA0NSAxLjc0NjQzIDUuNzA4MzMgMS40ODc1NCA2LjYwODQzIDEuMzY2NTJDNy40NzU0IDEuMjQ5OTYgOC41Nzc3MiAxLjI0OTk4IDkuOTQ1MzEgMS4yNVpNNC43NzY5NCAxOC4yNDkxQzQuNzkyMTQgMTguNjAyOSA0LjgxNTk3IDE4LjkxNCA0Ljg1MzMzIDE5LjE5MTlDNC45NTE5OSAxOS45MjU3IDUuMTMyNDMgMjAuMzE0MiA1LjQwOTIgMjAuNTkxQzUuNjg1OTYgMjAuODY3OCA2LjA3NDUzIDIxLjA0ODIgNi44MDgzMSAyMS4xNDY5QzcuNTYzNjYgMjEuMjQ4NCA4LjU2NDc3IDIxLjI1IDEwLjAwMDIgMjEuMjVIMTQuMDAwMkMxNS40MzU2IDIxLjI1IDE2LjQzNjcgMjEuMjQ4NCAxNy4xOTIxIDIxLjE0NjlDMTcuOTI1OCAyMS4wNDgyIDE4LjMxNDQgMjAuODY3OCAxOC41OTEyIDIwLjU5MUMxOC43ODc1IDIwLjM5NDcgMTguOTM1MyAyMC4xNDIxIDE5LjAzOTkgMTkuNzVIOC4wMDAxOUM3LjU4NTk3IDE5Ljc1IDcuMjUwMTkgMTkuNDE0MiA3LjI1MDE5IDE5QzcuMjUwMTkgMTguNTg1OCA3LjU4NTk3IDE4LjI1IDguMDAwMTkgMTguMjVIMTkuMjIzNEMxOS4yNDE5IDE3LjgxOSAxOS4yNDc3IDE3LjMyNDYgMTkuMjQ5NCAxNi43NUg3Ljg5Nzk2QzYuOTE5NzEgMTYuNzUgNi41Nzc3IDE2Ljc1NjQgNi4zMTU2MiAxNi44MjY3QzUuNTk2MyAxNy4wMTk0IDUuMDIyODYgMTcuNTU0MSA0Ljc3Njk0IDE4LjI0OTFaTTE5LjI1MDIgMTUuMjVINy44OTc5NkM3Ljg1ODc5IDE1LjI1IDcuODIwMiAxNS4yNSA3Ljc4MjE3IDE1LjI1QzYuOTY0MiAxNS4yNDk3IDYuNDA2MDUgMTUuMjQ5NSA1LjkyNzM5IDE1LjM3NzhDNS40OTk0MSAxNS40OTI1IDUuMTAyNDIgMTUuNjc5OCA0Ljc1MDE5IDE1LjkyNTlWOEM0Ljc1MDE5IDYuNTY0NTggNC43NTE3OCA1LjU2MzQ3IDQuODUzMzMgNC44MDgxMkM0Ljk1MTk5IDQuMDc0MzUgNS4xMzI0MyAzLjY4NTc3IDUuNDA5MiAzLjQwOTAxQzUuNjg1OTYgMy4xMzIyNSA2LjA3NDUzIDIuOTUxOCA2LjgwODMxIDIuODUzMTVDNy41NjM2NiAyLjc1MTU5IDguNTY0NzcgMi43NSAxMC4wMDAyIDIuNzVIMTQuMDAwMkMxNS40MzU2IDIuNzUgMTYuNDM2NyAyLjc1MTU5IDE3LjE5MjEgMi44NTMxNUMxNy45MjU4IDIuOTUxOCAxOC4zMTQ0IDMuMTMyMjUgMTguNTkxMiAzLjQwOTAxQzE4Ljg2NzkgMy42ODU3NyAxOS4wNDg0IDQuMDc0MzUgMTkuMTQ3IDQuODA4MTJDMTkuMjQ4NiA1LjU2MzQ3IDE5LjI1MDIgNi41NjQ1OCAxOS4yNTAyIDhWMTUuMjVaTTcuMjUwMTkgN0M3LjI1MDE5IDYuNTg1NzkgNy41ODU5NyA2LjI1IDguMDAwMTkgNi4yNUgxNi4wMDAyQzE2LjQxNDQgNi4yNSAxNi43NTAyIDYuNTg1NzkgMTYuNzUwMiA3QzE2Ljc1MDIgNy40MTQyMSAxNi40MTQ0IDcuNzUgMTYuMDAwMiA3Ljc1SDguMDAwMTlDNy41ODU5NyA3Ljc1IDcuMjUwMTkgNy40MTQyMSA3LjI1MDE5IDdaTTcuMjUwMTkgMTAuNUM3LjI1MDE5IDEwLjA4NTggNy41ODU5NyA5Ljc1IDguMDAwMTkgOS43NUgxMy4wMDAyQzEzLjQxNDQgOS43NSAxMy43NTAyIDEwLjA4NTggMTMuNzUwMiAxMC41QzEzLjc1MDIgMTAuOTE0MiAxMy40MTQ0IDExLjI1IDEzLjAwMDIgMTEuMjVIOC4wMDAxOUM3LjU4NTk3IDExLjI1IDcuMjUwMTkgMTAuOTE0MiA3LjI1MDE5IDEwLjVaIiBmaWxsPSIjZmZmIi8%2BIDwvZz4KDTwvc3ZnPg%3D%3D&labelColor=grey)](https://samuel-gfeller.ch/docs)
56
[![Latest Version on Packagist](https://img.shields.io/github/release/samuelgfeller/slim-api-starter.svg)](https://packagist.org/packages/samuelgfeller/slim-api-starter)
67
[![Code Coverage](https://scrutinizer-ci.com/g/samuelgfeller/slim-api-starter/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/samuelgfeller/slim-api-starter/?branch=master)
78
[![Build Status](https://scrutinizer-ci.com/g/samuelgfeller/slim-api-starter/badges/build.png?b=master)](https://scrutinizer-ci.com/g/samuelgfeller/slim-api-starter/build-status/master)
@@ -10,7 +11,7 @@
1011

1112

1213
[Slim 4](https://www.slimframework.com/) API starter template with a few examples and some essential [features](#features) to
13-
help you build a secure and scalable API following 2024 best practices and
14+
help you build a secure and scalable API following current best practices and
1415
[SOLID](https://en.wikipedia.org/wiki/SOLID) principles.
1516

1617
An extensive [**documentation**](https://samuel-gfeller.ch/docs) explains
@@ -100,9 +101,9 @@ Or you can serve it locally by running `php -S localhost:8080 -t public/` in the
100101
directory.
101102

102103
## Support
103-
If you value this project and want to support it,
104+
If you value this project and want to support it, star it on GitHub or
104105
visit the [Support❤️](https://samuel-gfeller.ch/docs/Support❤️) page. (thank you!)
105106

106107
## License
107108
This project is licensed under the MIT License — see the
108-
[LICENSE](https://github.com/samuelgfeller/slim-example-project/blob/master/LICENSE) file for details.
109+
[LICENSE](https://github.com/samuelgfeller/slim-api-starter/blob/master/LICENSE) file for details.

tests/docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Documentation:
1+
# Documentation
22
* [Unit vs Integration](https://samuel-gfeller.ch/docs/Unit-vs-Integration-Testing)
33
* [Test setup](https://samuel-gfeller.ch/docs/Test-Setup)
44
* [Writing Tests](https://samuel-gfeller.ch/docs/Writing-Tests)

0 commit comments

Comments
 (0)