Skip to content

Commit

Permalink
docs: add global installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adhocore committed Dec 28, 2019
1 parent b6722e8 commit ddcbfd4
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,30 @@


## Installation

### As standalone binary

```sh
composer global require adhocore/cli-syntax

# then you will be able to run it as
clish -h
clish -f file.php
echo '<?php date("Ymd");' | clish
cat file.php | clish

# export png
clish -f file.php -o file.png
```

### As project dependency
```bash
composer require adhocore/cli-syntax
```

## Usage

You can either highlight PHP code in CLI or export to png image.
You can either highlight PHP code in terminal output or export to png image.

### Highlight

Expand Down

0 comments on commit ddcbfd4

Please sign in to comment.