Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
veewee committed Nov 29, 2019
1 parent a9e5197 commit 5a2ec0f
Showing 1 changed file with 4 additions and 15 deletions.
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,10 @@

This package provides GrumPHP without the struggle of installing all of its dependencies.

## Usage

Currently this shim is still beta and not globally available in composer.
This means you'll need to configure a repository in the meantime:

```bash
composer config repositories.grumphp-shim vcs https://github.com/phpro/grumphp-shim
```

Install the package. (Currently dev-master only!)
## Installation

```bash

composer require --dev phpro/grumphp-shim:dev-master
composer require --dev phpro/grumphp-shim
```

and use it like the original executable
Expand All @@ -24,11 +14,10 @@ and use it like the original executable
vendor/bin/grumphp.phar run
```

Check out the main repo for more options [https://github.com/phpro/grumphp](https://github.com/phpro/grumphp).
Check out the main repo for more options and release notes
[https://github.com/phpro/grumphp](https://github.com/phpro/grumphp).


## TODO

- Rewrite composer hook so that it requires NO dependencies and copy from source!! (Currently not useable ...)
- Register phive repository : https://github.com/phar-io/phar.io/blob/master/data/repositories.xml
- Optionally: Inject https://github.com/humbug/phar-updater during build

0 comments on commit 5a2ec0f

Please sign in to comment.