Clean up docs, structure

Author: MGatner

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Tatter Software
+Copyright (c) 2019-2020 Tatter Software
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -6,6 +6,7 @@ Lightweight object logging for CodeIgniter 4
 1. Install with Composer: `> composer require tatter/audits`
 2. Update the database: `> php spark migrate -all`
 3. Setup your models:
+
 ```
 class JobModel extends Model
 {
@@ -14,7 +15,7 @@ class JobModel extends Model
 	protected $afterUpdate = ['auditUpdate'];
 	protected $afterDelete = ['auditDelete'];
 ```
-4. All done!
+
 
 ## Features
 
@@ -33,45 +34,35 @@ Once the files are downloaded and included in the autoload, run any library migr
 to ensure the database is setup correctly:
 * `> php spark migrate -all`
 
-**Pro Tip:** You can add the spark command to your composer.json to ensure your database is
-always current with the latest release:
-```
-{
-	...
-    "scripts": {
-        "post-update-cmd": [
-            "composer dump-autoload",
-            "php spark migrate -all"
-        ]
-    },
-	...
-```
-
 ## Configuration (optional)
 
 The library's default behavior can be altered by extending its config file. Copy
-**bin/Audits.php** to **app/Config/Audits.php** and follow the instructions in the
+**examples/Audits.php** to **app/Config/Audits.php** and follow the instructions in the
 comments. If no config file is found in **app/Config** the library will use its own.
 
 ## Usage
 
 Once the library is included all the resources are ready to go and you just need to
 specify which models and events to audit. Use AuditsTrait to add support to any models
 you would like tracked:
+
 ```
 class JobModel extends Model
 {
 	use \Tatter\Audits\Traits\AuditsTrait;
 ```
+
 Then specify which events you want audited by assigning the corresponding audit methods
 for those events:
+
 ```
 	protected $afterInsert = ['auditInsert'];
 	protected $afterUpdate = ['auditUpdate'];
 	protected $afterDelete = ['auditDelete'];
 ```
 
 The Audits library will create basic logs of each event in the `audits` table, for example:
+
 ```
 | id | source | source_id | user_id | event  | summary  |          created_at |
 +----+--------+-----------+---------+--------+----------+---------------------+

composer.json

@@ -19,7 +19,7 @@
 		}
 	],
 	"require": {
-		"php" : "^7.0"
+		"php" : ">=7.2"
 	},
 	"require-dev": {
 		"codeigniter4/framework": "dev-master"
@@ -31,8 +31,7 @@
 	},
 	"scripts": {
 		"post-update-cmd": [
-			"composer dump-autoload",
-			"php spark migrate:latest -n all"
+			"composer dump-autoload"
 		]
 	}
 }

bin/Audits.php examples/Audits.phpbin/Audits.php renamed to examples/Audits.php

@@ -10,13 +10,11 @@
 *
 ***/
 
-use CodeIgniter\Config\BaseConfig;
-
 class Audits extends \Tatter\Audits\Config\Audits
 {
-	// key in $_SESSION that contains the integer ID of a logged in user
+	// Session key in that contains the integer ID of a logged in user
 	public $sessionUserId = "logged_in";
 
-	// whether to continue instead of throwing exceptions
+	// Whether to continue instead of throwing exceptions
 	public $silent = true;
 }

src/Config/Audits.php

@@ -4,9 +4,9 @@
 
 class Audits extends BaseConfig
 {
-	// key in $_SESSION that contains the integer ID of a logged in user
+	// Session key in that contains the integer ID of a logged in user
 	public $sessionUserId = "logged_in";
 
-	// whether to continue instead of throwing exceptions
+	// Whether to continue instead of throwing exceptions
 	public $silent = true;
 }