Skip to content

Commit b6ef5a0

Browse files
Update README.md
Add the thumbnail and slim down readme and point to the documentation site.
1 parent a48b5a7 commit b6ef5a0

File tree

1 file changed

+8
-43
lines changed

1 file changed

+8
-43
lines changed

README.md

Lines changed: 8 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22

33
Backup is an extensible and powerful backup tool for statamic sites, it enables you to create, manage and schedule backups of your site with ease in the control panel.
44

5+
![image](https://github.com/user-attachments/assets/3dfe3930-8997-4e73-a270-342585c75fee)
6+
57
## Table of Contents
68

79
- [Features](#features)
810
- [Installation](#installation)
9-
- [Configuration](#configuration)
10-
- [Usage](#usage)
11-
- [Scheduling](#scheduling)
1211
- [Documentation](#documentation)
1312
- [License](#license)
1413

@@ -22,10 +21,14 @@ Why use our backup addon?
2221
- Choose exactly what you want to backup by configuring the backup [pipeline](docs/pipeline.md).
2322
- Easy to extend and customize, [just create a new pipes](docs/pipeline.md#creating-a-new-backup-pipe)!
2423
- Uses laravels [storage system](https://laravel.com/docs/11.x/filesystem) and thus supports external storage out of the box.
25-
- Tested, we have over 140 assertions in this addon.
24+
- Tested, the addon have over 85% test coverage.
2625

2726
## Installation
2827

28+
Read the more detailed guide in the documentation, [here](https://itiden.github.io/statamic-backup/getting-started.html).
29+
30+
Otherwise, here is a "quickstart guide":
31+
2932
1. To install this addon, require it using composer.
3033

3134
```bash
@@ -36,48 +39,10 @@ Why use our backup addon?
3639
```bash
3740
php artisan vendor:publish --tag="backup-config"
3841
```
39-
default is `storage_path('content')`
40-
41-
## Configuration
42-
43-
You can configure the backup settings in the `config/backup.php` file, first publish the configuration file using the following command:
44-
45-
```bash
46-
php artisan vendor:publish --tag="backup-config"
47-
```
48-
49-
Then you can configure:
50-
51-
- Backup path
52-
- Backup disk
53-
- Backup filename
54-
- Backup schedule
55-
- Temporary files path
56-
- Max amount of backups to keep
57-
- Backup password
58-
- The Backup pipeline
59-
60-
Read more about the configuration [here](docs/configuration.md)!
61-
62-
## Usage
63-
64-
To create a backup, navigate to the Backup section in the control panel and click the "Create Backup" button. There you can also see a list of all your backups and download or restore them if needed.
65-
66-
Or if you prefer to use the command line, you can use the following command:
67-
68-
```bash
69-
php artisan statamic:backup:create
70-
```
71-
72-
### Scheduling
73-
74-
Configure the backup schedule in the configuration file, read more about it [here](docs/scheduling.md).
75-
76-
To use the scheduling you need to run the laravel scheduler. Read more about that here: [Running the scheduler](https://laravel.com/docs/10.x/scheduling#running-the-scheduler).
7742

7843
## Documentation
7944

80-
In the docs directory you can read more about the pipeline, scheduling and notification configurations.
45+
Read more about configuration, installation, usage and more advanced topics in our [documentation](https://itiden.github.io/statamic-backup/)!
8146

8247
## License
8348

0 commit comments

Comments
 (0)