Skip to content

Commit

Permalink
Updated documentation with new tools and formatting consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
asgrim committed Aug 20, 2019
1 parent 3a976d7 commit 085069d
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 21 deletions.
38 changes: 26 additions & 12 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -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
```
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

Email us at [email protected] 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

Expand All @@ -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

Expand Down

0 comments on commit 085069d

Please sign in to comment.