From 085069d0710fb442851624d2c3c1c566701f425f Mon Sep 17 00:00:00 2001 From: James Titcumb Date: Tue, 20 Aug 2019 10:58:54 +0100 Subject: [PATCH] Updated documentation with new tools and formatting consistency --- DEVELOPMENT.md | 38 ++++++++++++++++++++++++++------------ README.md | 17 ++++++++--------- 2 files changed, 34 insertions(+), 21 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index c540f4f0..2278755d 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,21 +1,35 @@ -Dev Guide -========= +# Dev Guide -Setup ------ +## Setup - composer install +```bash +composer install +``` +## Running tests -Running tests -------------- +```bash +vendor/bin/phpunit +``` - vendor/bin/phpunit +## Writing Code +### Checking for static analysis issues -Writing Code ------------- +```bash +vendor/bin/psalm +``` -We have an automated style fixer called php-cs-fixer. Style is checked on TravisCI as well. +### Checking coding standards are met - vendor/bin/php-cs-fixer fix +```bash +vendor/bin/phpcs +``` + +### Fixing coding standards automatically + +We have an automated style fixer called PHP Code Sniffer. Style is checked on TravisCI as well. + +```bash +vendor/bin/phpcbf +``` diff --git a/README.md b/README.md index ae801dd7..a96c0e9f 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,9 @@ Email us at support@ScoutAPM.com to get on the beta invite list! -Monitor the performance of PHP Laravel apps with Scout's -[PHP APM Agent](https://www.scoutapm.com). -Detailed performance metrics and transaction traces are collected once the -agent is installed and configured. +Monitor the performance of PHP apps with Scout's [PHP APM Agent](https://www.scoutapm.com). +Detailed performance metrics and transaction traces are collected once the agent is installed and configured. ## Requirements @@ -15,15 +13,16 @@ PHP Versions: 7.1+ ## Quick Start This package is the base library for the various framework-specific packages. -To install the ScoutAPM Agent for a specific framework, use the specific -package instead. -* [Laravel](https://github.com/scoutapp/scout-apm-laravel) +### Laravel + +To install the ScoutAPM Agent for a specific framework, use the specific package instead. + + * [Laravel](https://github.com/scoutapp/scout-apm-laravel) ## Documentation -For full installation and troubleshooting documentation, visit our -[help site](http://docs.scoutapm.com/#php-agent). +For full installation and troubleshooting documentation, visit our [help site](http://docs.scoutapm.com/#php-agent). ## Support