Skip to content

Commit

Permalink
md lint
Browse files Browse the repository at this point in the history
  • Loading branch information
fezfez committed Oct 12, 2023
1 parent aa22b29 commit 4867c84
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,14 @@
[![Latest Stable Version](https://poser.pugx.org/fezfez/backup-manager/v/stable)](https://packagist.org/packages/fezfez/backup-manager)
[![License](https://poser.pugx.org/fezfez/backup-manager/license)](https://packagist.org/packages/fezfez/backup-manager)


This package provides a framework-agnostic database backup manager for dumping to and restoring databases from any file system.

- supports `MySQL` and `PostgreSQL`
- compress with `Gzip`
- framework-agnostic
- dead simple configuration

### Quick and Dirty
## Quick and Dirty

**Backup to / restore from any configured database.**

Expand Down Expand Up @@ -59,7 +58,7 @@ $manager->restore(
);
```

**Backup to / restore from any configured filesystem.**
### Backup to / restore from any configured filesystem

Restore the database file `test/backup.sql.gz` from `Amazon S3` to the `development` database.

Expand All @@ -70,17 +69,16 @@ $manager->makeRestore()->run('s3', 'test/backup.sql.gz', 'development', 'gzip');

> This package does not allow you to backup from one database type and restore to another. A MySQL dump is not compatible with PostgreSQL.
### Requirements
## Requirements

- PHP ^8.0
- MySQL support requires `mysqldump` and `mysql` command-line binaries
- PostgreSQL support requires `pg_dump` and `psql` command-line binaries
- Gzip support requires `gzip` and `gunzip` command-line binaries


### Installation

**Composer**
### Composer

Run the following to include this via Composer

Expand All @@ -101,29 +99,27 @@ composer require fezfez/backup-manager-league-flysystem-v2
composer require fezfez/backup-manager-league-flysystem-v3
```

### Usage
## Usage

Once installed, the package must be bootstrapped (initial configuration) before it can be used.

We've provided a native PHP example [here](https://github.com/backup-manager/backup-manager/tree/master/examples).

The required bootstrapping can [be found in the example here](https://github.com/backup-manager/backup-manager/blob/master/examples/standalone/bootstrap.php).


### Contribution Guidelines
## Contribution Guidelines

We recommend using the vagrant configuration supplied with this package for development and contribution. Simply install VirtualBox, Vagrant, and Ansible then run `vagrant up` in the root folder. A virtualmachine specifically designed for development of the package will be built and launched for you.

When contributing please consider the following guidelines:

- Code style is PSR-2
- Interfaces should NOT be suffixed with `Interface`, Traits should NOT be suffixed with `Trait`.
- Interfaces should NOT be suffixed with `Interface`, Traits should NOT be suffixed with `Trait`.
- All methods and classes must contain docblocks.
- Ensure that you submit tests that have minimal 100% coverage. Given the project's simplicity it just makes sense.
- When planning a pull-request to add new functionality, it may be wise to [submit a proposal](https://github.com/backup-manager/backup-manager/issues/new) to ensure compatibility with the project's goals.


### Backwards Compatibility Breaks
## Backwards Compatibility Breaks

### License

Expand Down

0 comments on commit 4867c84

Please sign in to comment.