Skip to content

Commit

Permalink
update index.md (#1430)
Browse files Browse the repository at this point in the history
remove suggesting shim
  • Loading branch information
gennadigennadigennadi committed Jul 10, 2024
1 parent eba3a75 commit d4f13c4
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,16 @@ You can analyse projects that require an older PHP version as long as

## Installation

You can install Deptrac via Composer. We recommend using the [deptrac-shim](https://github.com/qossmic/deptrac-shim) package for this.
You can install Deptrac via Composer. We recommend using the [deptrac](https://github.com/qossmic/deptrac) package for this.
Alternatively, you can also use [PHIVE](#phive) or download the
[PHAR](#phar) attached to each release on GitHub.
This will ensure that Deptrac and its dependencies are
bundled together and will not interfere with any of your project's dependencies.

### Composer

We strongly advise against using the deptrac package directly as a composer dependency.
We update dependencies regularly, which might cause disruptions in your project.
Instead, please use the dedicated distribution repository <https://github.com/qossmic/deptrac-shim>.

When you install Deptrac using the qossmic/deptrac-shim package, you will get
the benefit of using the phar installation, but you can use it like any other
composer dependency, i.e. you run Deptrac like this:

```console
$ composer require --dev qossmic/deptrac-shim
$ composer require --dev qossmic/deptrac
vendor/bin/deptrac analyse
```

Expand All @@ -61,7 +53,7 @@ Feel free to add Deptrac to your PATH (i.e. `/usr/local/bin/deptrac`) to make it
globally available.

```console
$ curl -LS https://github.com/qossmic/deptrac/releases/download/1.0.2/deptrac.phar -o deptrac.phar
$ curl -LS https://github.com/qossmic/deptrac/releases/download/2.0.1/deptrac.phar -o deptrac.phar

# optional
$ sudo chmod +x deptrac.phar
Expand All @@ -75,7 +67,7 @@ You can install Deptrac with [Phive](https://phar.io/#Install)
`phive install -g qossmic/deptrac`

and accept the key with fingerprint
`41DD E075 4745 9FAE CFA1 7813 B8F6 4013 4AB1 782E`.
`57CB 556F 242F C8D4 FD48 3C2C 4743 6587 D82C 4A39`.

To upgrade Deptrac use the following command:

Expand Down

0 comments on commit d4f13c4

Please sign in to comment.