Skip to content

Commit df0db6f

Browse files
Update README.md
1 parent 6551155 commit df0db6f

File tree

1 file changed

+5
-20
lines changed

1 file changed

+5
-20
lines changed

README.md

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# cakephp-database-backup
22

33
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.txt)
4-
[![CI](https://github.com/mirko-pagliai/cakephp-database-backup/actions/workflows/ci.yml/badge.svg)](https://github.com/mirko-pagliai/cakephp-database-backup/actions/workflows/ci.yml)
4+
[![CI](https://github.com/mirko-pagliai/cakephp-database-backup/actions/workflows/ci.yml/badge.svg?branch=2.14.x)](https://github.com/mirko-pagliai/cakephp-database-backup/actions/workflows/ci.yml)
55
[![codecov](https://codecov.io/gh/mirko-pagliai/cakephp-database-backup/graph/badge.svg?token=nkaJk4nvus)](https://codecov.io/gh/mirko-pagliai/cakephp-database-backup)
66
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/cd12284c1047431c8149e09fa56536bf)](https://app.codacy.com/gh/mirko-pagliai/cakephp-database-backup/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
77
[![CodeFactor](https://www.codefactor.io/repository/github/mirko-pagliai/cakephp-database-backup/badge)](https://www.codefactor.io/repository/github/mirko-pagliai/cakephp-database-backup)
@@ -52,7 +52,7 @@ files. So you have to create the directory and make it writable:
5252
$ mkdir backups/ && chmod 775 backups/
5353
```
5454

55-
If you want to use a different directory, read the [Configuration](#configuration) section.
55+
If you want to use a different directory, read the [Configuration](docs/Configuration.md) page.
5656

5757
### Installation on older CakePHP and PHP versions
5858

@@ -69,26 +69,11 @@ least PHP `>=5.6 <7.4` and CakePHP `^3.5.1`.
6969
You can freely use these tags, even by downloading the source codes from the attached assets, but their functioning is
7070
no longer guaranteed, especially regarding old dependencies that may no longer be available.
7171

72-
## Configuration
73-
The plugin uses some configuration parameters. See our wiki:
74-
* [Configuration](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Configuration)
72+
## Configuration and How to use
7573

76-
If you want to send backup files by email, remember to set up your application
77-
correctly so that it can send emails. For more information on how to configure
78-
your application, see the [CakePHP documentation](https://book.cakephp.org/5/en/core-libraries/email.html#configuring-transports).
74+
See [our wiki](/docs).
7975

80-
## How to use
81-
82-
See our wiki:
83-
* [How to use commands](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-commands)
84-
* [Export backups as cron jobs](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Export-backups-as-cron-jobs)
85-
* [How to use the BackupExport utility](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupExport-utility)
86-
* [How to use the BackupImport utility](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupImport-utility)
87-
* [How to use the BackupManager utility](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupManager-utility)
88-
* [Create backup copies](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Create-backup-copies)
89-
* [Send backups via email](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Send-backups-via-email)
90-
91-
Before opening an issue, check this list of [common issues](https://github.com/mirko-pagliai/cakephp-database-backup/wiki/Common-issues).
76+
Before opening an issue, check this list of [common issues](docs/Common%20issues.md).
9277

9378
## Testing
9479

0 commit comments

Comments
 (0)