3.cake5

.editorconfig

@@ -0,0 +1,21 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.neon]
+indent_style = tab
+
+[phars.xml]
+indent_size = 2
+
+[*.js]
+indent_size = 2

.gitignore

@@ -0,0 +1,32 @@
+/composer.lock
+*.diff
+*.err
+*.log
+*.orig
+*.rej
+*.swo
+*.swp
+*.vi
+*~
+.idea/*
+nbproject/*
+.vscode
+.DS_Store
+.cache
+.phpunit.cache
+.project
+.settings
+.svn
+errors.err
+tags
+node_modules
+package-lock.json
+/.phpunit.result.cache
+/nbproject/
+/tools
+/vendor
+/phpunit.xml
+/webroot/css/style.css.map
+/webroot/mix.js.map
+/webroot/mix-manifest.json
+.ddev/*

README.md

@@ -1,6 +1,6 @@
 # CakePHP <3 NewRelic
 
-You can modify your files like this
+You can modify your files like this to have full NewRelic support.
 
 ## Things included
 
@@ -9,9 +9,21 @@ You can modify your files like this
 - NewRelicTrait trait
 - NewRelic.NewRelic
 
-### Console
+## Requirements
+- [New Relic PHP agent](https://docs.newrelic.com/docs/agents/php-agent/getting-started/introduction-new-relic-php) installed as a PHP module
 
-Include this snippet in `app/Console/AppShell.php`
+## Installation
+
+Note: This branch is for CakePHP 5.x
+
+```
+composer require jippi/cakephp-newrelic:dev-cake4
+```
+
+
+### Shell
+
+Include this snippet in `src/Shell/AppShell.php`
 
 ```php
 	public function startup() {
@@ -29,12 +41,11 @@ Include this snippet in `app/Console/AppShell.php`
 
 Simply add `NewRelic.NewRelic` to your `$components` list
 
-## app/webroot/index.php
+## webroot/index.php
 
 Add this in top of your file before `define('DS', 'DIRECTORY_SEPARATOR')`
 
 ```php
-<?php
 require_once dirname(dirname(__DIR__)) . '/vendors/autoload.php';
 
 if (extension_loaded('newrelic')) {
@@ -55,10 +66,9 @@ if (extension_loaded('newrelic')) {
 // Rest of your index.php here
 ```
 
-## app/Console/cake.php
+## bin/cake.php
 
 ```php
-<?php
 require_once dirname(dirname(__DIR__)) . '/vendors/autoload.php';
 
 if (extension_loaded('newrelic')) {