summaryrefslogtreecommitdiff
path: root/vendor/sebastian/version/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/sebastian/version/README.md')
-rw-r--r--vendor/sebastian/version/README.md43
1 files changed, 0 insertions, 43 deletions
diff --git a/vendor/sebastian/version/README.md b/vendor/sebastian/version/README.md
deleted file mode 100644
index 2864c8126..000000000
--- a/vendor/sebastian/version/README.md
+++ /dev/null
@@ -1,43 +0,0 @@
-# Version
-
-**Version** is a library that helps with managing the version number of Git-hosted PHP projects.
-
-## Installation
-
-You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
-
- composer require sebastian/version
-
-If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency:
-
- composer require --dev sebastian/version
-
-## Usage
-
-The constructor of the `SebastianBergmann\Version` class expects two parameters:
-
-* `$release` is the version number of the latest release (`X.Y.Z`, for instance) or the name of the release series (`X.Y`) when no release has been made from that branch / for that release series yet.
-* `$path` is the path to the directory (or a subdirectory thereof) where the sourcecode of the project can be found. Simply passing `__DIR__` here usually suffices.
-
-Apart from the constructor, the `SebastianBergmann\Version` class has a single public method: `getVersion()`.
-
-Here is a contrived example that shows the basic usage:
-
- <?php
- $version = new SebastianBergmann\Version(
- '3.7.10', '/usr/local/src/phpunit'
- );
-
- var_dump($version->getVersion());
- ?>
-
- string(18) "3.7.10-17-g00f3408"
-
-When a new release is prepared, the string that is passed to the constructor as the first argument needs to be updated.
-
-### How SebastianBergmann\Version::getVersion() works
-
-* If `$path` is not (part of) a Git repository and `$release` is in `X.Y.Z` format then `$release` is returned as-is.
-* If `$path` is not (part of) a Git repository and `$release` is in `X.Y` format then `$release` is returned suffixed with `-dev`.
-* If `$path` is (part of) a Git repository and `$release` is in `X.Y.Z` format then the output of `git describe --tags` is returned as-is.
-* If `$path` is (part of) a Git repository and `$release` is in `X.Y` format then a string is returned that begins with `X.Y` and ends with information from `git describe --tags`.