You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-5
Original file line number
Diff line number
Diff line change
@@ -14,23 +14,41 @@ Calculates the total number of years behind their respective newest versions for
14
14
15
15
## Requirements
16
16
17
-
- PHP 7.4 or later
17
+
- PHP v7.4 or later
18
+
- Composer v2
18
19
19
20
## Installation
20
21
21
-
Simply download `libyear.phar` from the latest release.
22
+
### Recommended: Composer
22
23
23
-
Put it in the current directory, or your `$PATH` to be able to reference it from anywhere.
24
+
Run `composer global require ecoapm/libyear` and make sure your global composer directory is in your `$PATH`.
25
+
26
+
Alternatively, `composer require-dev ecoapm/libyear` will add `libyear` as a local dev dependency for your current directory's app.
27
+
28
+
### Alternative: PHP Archive (PHAR) File
29
+
30
+
Download `libyear.phar` from the latest release, and put it in the current directory, or somewhere in your `$PATH` to be able to reference it from anywhere.
31
+
32
+
### Windows Users
33
+
34
+
Note that PHP for Windows does not include CA certificates, so you'll need to install them if you haven't done so already:
35
+
1. Download http://curl.haxx.se/ca/cacert.pem to somewhere permanent (PHP's `extras` directory is a great place)
36
+
1. Add `curl.cainfo = "[full path to]\cacert.pem"` to your `php.ini` file
24
37
25
38
## Usage
26
-
`php libyear.phar { path to project } [-q]`
39
+
40
+
`vendor/bin/libyear { path to project } [-q]`
41
+
42
+
(or `php path/to/libyear.phar { path to project } [-q]` for the PHAR version)
27
43
28
44
Arguments:
29
45
-`path to project`: required, directory containing `composer.json` and `composer.lock` files
30
46
-`-q`: optional, quiet mode will only output libraries which are not up-to-date (that is, where "Libyears Behind" > 0)
31
47
32
48
## Contributing
33
49
34
-
When testing new features and bug fixes, you can run the script via `php libyear.php { path } [-q]` before building the `phar` file.
50
+
Please be sure to read and follow ecoAPM's [Contribution Guidelines](CONTRIBUTING.md) when submitting issues or pull requests.
51
+
52
+
When testing new features and bug fixes, you can run the script via `./libyear { path } [-q]` before building the `phar` file.
35
53
36
54
To build the `phar` file for final manual testing, run `php -dphar.readonly=0 build.php`. You may wish to run `composer install --no-dev` first to speed up the build process by removing dev dependencies, but will need to reinstall them via `composer install` (specifically, `phpunit` and `mockery` for unit testing).
0 commit comments