Skip to content

Commit

Permalink
Merge pull request #10 from apple-x-co/refactor-readme
Browse files Browse the repository at this point in the history
refactor readme
  • Loading branch information
apple-x-co authored Mar 28, 2021
2 parents 13a9abe + e5adf41 commit 0b624f4
Showing 1 changed file with 24 additions and 21 deletions.
45 changes: 24 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,48 @@
# rocket

## How to
## Requirement

* PHP 5.6+

## Installation

```bash
# print rocket.json
php ./rocket.phar --init > ./rocket.json
wget https://github.com/apple-x-co/rocket/releases/download/0.1.7/rocket.phar
chmod u+x rocket.phar
./rocket.phar --init > ./rocket.json
```

```bash
# notification test
php ./rocket.phar --rocket ./rocket.json --notify-test
# slack notification test
./rocket.phar --config ./rocket.json --notify-test

# verify rocket.json
php ./rocket.phar --rocket ./rocket.json --verify
./rocket.phar --config ./rocket.json --verify
```

## Update

```bash
./rocket.phar --upgrade
```

## Usage

```bash
# dry run (default)
php ./rocket.phar --rocket ./rocket.json --sync dry
./rocket.phar --config ./rocket.json --sync dry

# git pull & sync confirm
php ./rocket.phar --rocket ./rocket.json --git pull --sync confirm
./rocket.phar --config ./rocket.json --git pull --sync confirm

# git pull & sync force (crontab)
php ./rocket.phar --rocket ./rocket.json --git pull --sync force
./rocket.phar --config ./rocket.json --git pull --sync force

# not git
php ./rocket.phar --rocket ./rocket.json --sync confirm
```

```bash
# upgrade
php ./rocket.phar --upgrade

# upgrade (no ZipArchive)
php ./rocket.phar --upgrade --unzip /usr/bin/unzip
./rocket.phar --config ./rocket.json --sync confirm
```

## Development

### Build
## Build phar file

```bash
composer run-script build
Expand Down

0 comments on commit 0b624f4

Please sign in to comment.