Added data rotation function

.gitignore

@@ -1,3 +1,6 @@
 node_modules/
 .idea/
 .vscode/
+*.log
+audits
+.env.**

README.md

@@ -132,6 +132,78 @@ await myModel
   .delete()
 ```
 
+# Rotation
+
+## Register provider
+
+Once you have installed adonis-audit, make sure to register the provider inside `start/app.js` in order to make use of it.
+
+```js
+const providers = ['@ks-labs/adonis-audit/providers/AuditRotationProvider']
+```
+
+## Register Command
+
+Register the command inside `start/app/js`
+
+```js
+const command = ['@ks-labs/adonis-audit/src/Command/AuditCommand']
+```
+
+Initialize audit command
+
+```js
+adonis make:auditRotation
+```
+
+The above command will create the rotation audit configuration file
+
+`config/audit.js`
+
+```js
+'use strict'
+
+const Env = use('Env')
+
+module.exports = {
+  // redis connection
+  enabled: Env.get('ENABLED_AUDIT_ROTATION', true),
+  retention: Env.get('RETENTION_AUDIT_ROTATION', '3'),
+  pruneDatabase: Env.get('PRUNE_DATABASE_AUDIT_ROTATION', true),
+  deleteFileAfterUpload: Env.get('DELETE_FILE_AFTER_UPLOAD_AUDIT_ROTATION', true),
+
+  logger: {
+    'level': 'debug',
+    'transport': 'pino-pretty',
+    'pino-pretty': {
+      level: 'info',
+      target: 'pino-pretty',
+    },
+  },
+}
+```
+
+### _It is highly important to add an index to the `created_at` column of the audit table to improve performance in queries performed by data rotation_
+
+## Use
+
+You can use the lib's scheduling service `schedule()` or create your own rotation strategy using the `run()` command.
+
+```js
+/** @type { import('../src/Rotation/index')} */
+const DataRotation = ioc.use('Adonis/Addons/DataRotation')
+
+// Run rotation
+await DataRotation.run()
+
+// Run scheduling
+await DataRotation.schedule('* * * * * ')
+```
+
+## Diagram
+
+![Alt text](d__Documents_3C_adonis-audit_retention.svg)
+
 ## Built For
 
 - [Legacy AdonisJS 4.1](http://legacy.adonisjs.com) - The web framework used.

bin/dev.japaFile.js

@@ -3,7 +3,7 @@
 const { configure } = require('japa')
 
 configure({
-  files: ['test/*.test.js', 'test/*.spec.js'],
+  files: ['test/*.test.js', 'test/*.spec.js'],,
 
   timeout: 30000,
 })