Skip to content

Commit

Permalink
phive installation method (#7)
Browse files Browse the repository at this point in the history
* phive installation method

* no message
  • Loading branch information
seferov authored Oct 21, 2019
1 parent eeb9090 commit c12fc20
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 11 deletions.
2 changes: 0 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ script:

matrix:
fast_finish: true
allow_failures:
- php: 7.4snapshot

jobs:
include:
Expand Down
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,43 @@ For optional config file, see the [current project example](https://github.com/s

## Installation

Install via composer:

`
composer require seferov/typhp
`
There are several ways to install `typhp`. The recommended one is to use
phar distribution. Thus you won't have possible dependency conflict.

To install globally
#### Phar

`
Direct download from the [latest Github release](https://github.com/seferov/typhp/releases/latest)

```bash
wget https://github.com/seferov/typhp/releases/download/v0.1.2/typhp.phar -O typhp
chmod +x typhp
```

You can install phar distribution by [Phive](https://phar.io/)

```bash
phive install seferov/typhp --global
```

#### Composer

`typhp` can be installed by [composer](https://getcomposer.org/) globally.

```bash
composer global require seferov/typhp
`
```

If you prefer, you can it add dev dependency to your project.

Not to have possible dependency conflict, you can download PHAR file from the [latest Github release](https://github.com/seferov/typhp/releases/latest)
```bash
composer require require seferov/typhp --dev
```

## Usage

`
vendor/bin/typhp analyse path
typhp analyse path
`

If config file (`.typhp.yml`) is present in project root, it can be run
Expand All @@ -62,6 +81,8 @@ Example output

- [x] Phar file

- [ ] Auto deploy phar file to release assets & add self-update command

- [ ] Github Actions


Expand Down

0 comments on commit c12fc20

Please sign in to comment.