From ef675fff12db3bcfaff1ad7cb88177d5f52dd1f9 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J <64917965+TavoNiievez@users.noreply.github.com> Date: Tue, 12 Jan 2021 09:10:07 -0500 Subject: [PATCH] Standardize the `README` format --- readme.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index ca0e7db..47415b8 100644 --- a/readme.md +++ b/readme.md @@ -1,13 +1,24 @@ -# Codeception module for testing local filesystem +# Codeception Module Filesystem -![Build Status](https://github.com/Codeception/module-filesystem/workflows/CI/badge.svg) +A Codeception module for testing local filesystem. + +[![Actions Status](https://github.com/Codeception/module-filesystem/workflows/CI/badge.svg)](https://github.com/Codeception/module-filesystem/actions) +[![Latest Stable Version](https://poser.pugx.org/codeception/module-filesystem/v/stable)](https://github.com/Codeception/module-filesystem/releases) +[![Total Downloads](https://poser.pugx.org/codeception/module-filesystem/downloads)](https://packagist.org/packages/codeception/module-filesystem) +[![License](https://poser.pugx.org/codeception/module-filesystem/license)](/LICENSE) ## Installation ``` -composer require --dev "codeception/module-filesystem" +composer require "codeception/module-filesystem" --dev ``` ## Documentation -Module documentation +See [the module documentation](https://codeception.com/docs/modules/Filesystem). + +## License + +`Codeception Module Filesystem` is open-sourced software licensed under the [MIT](/LICENSE) License. + +© Codeception PHP Testing Framework