Skip to content

Commit 87b72e3

Browse files
authored
Update readme (#22)
1 parent bfa96f3 commit 87b72e3

File tree

1 file changed

+15
-30
lines changed

1 file changed

+15
-30
lines changed

README.md

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@
2828
### Normalize Versions
2929

3030
Normalizes a version string to be able to perform comparisons on it.
31-
This is a wrapper of the [
32-
`Composer\Semver\VersionParser::normalize()`](https://github.com/composer/semver/blob/b52829022cb18210bb84e44e457bd4e890f8d2a7/src/VersionParser.php#L98-L108)
33-
method.
31+
This is a wrapper of the [`Composer\Semver\VersionParser::normalize()`](https://github.com/composer/semver/blob/b52829022cb18210bb84e44e457bd4e890f8d2a7/src/VersionParser.php#L98-L108) method.
3432

3533
```console
3634
$ composer-semver normalize '1.2-p.5+foo'
@@ -75,9 +73,7 @@ Help:
7573
### Parse Constraints
7674

7775
Parses a constraint string and strip its ignorable parts.
78-
This is a wrapper of the [
79-
`Composer\Semver\VersionParser::parseConstraints()`](github.com/composer/semver/blob/b52829022cb18210bb84e44e457bd4e890f8d2a7/src/VersionParser.php#L251-L258)
80-
method.
76+
This is a wrapper of the [`Composer\Semver\VersionParser::parseConstraints()`](github.com/composer/semver/blob/b52829022cb18210bb84e44e457bd4e890f8d2a7/src/VersionParser.php#L251-L258) method.
8177

8278
```console
8379
$ composer-semver parse '>=1.2 <2.0 || ~3.4.5 || ^6.7'
@@ -133,8 +129,8 @@ For shell completions, follow the instructions from:
133129
$ composer-semver completion --help
134130
```
135131

136-
If you installed `Composer SemVer` [via Homebrew](#homebrew-macos--linux-recommended), completion scripts are managed by
137-
Homebrew. Read more at https://docs.brew.sh/Shell-Completion
132+
If you installed `Composer SemVer` [via Homebrew](#homebrew-macos--linux-recommended), completion scripts are managed by Homebrew.
133+
Read more at https://docs.brew.sh/Shell-Completion
138134

139135
---
140136

@@ -157,15 +153,11 @@ Homebrew. Read more at https://docs.brew.sh/Shell-Completion
157153
>
158154
> -- [Composer FAQ](https://getcomposer.org/doc/faqs/which-version-numbering-system-does-composer-itself-use.md)
159155
160-
Under the hood, Composer uses [`composer/semver`](https://packagist.org/packages/composer/semver) to parse and validate
161-
versions.
156+
Under the hood, Composer uses [`composer/semver`](https://packagist.org/packages/composer/semver) to parse and validate versions.
162157

163-
Despite the lie
164-
on [Composer FAQ](https://getcomposer.org/doc/faqs/which-version-numbering-system-does-composer-itself-use.md),
165-
the [fragmentary documentation](https://getcomposer.org/doc/articles/versions.md), and the deceitful package name
166-
`composer/semver`, Composer implements only a subset of [Semantic Versioning](https://semver.org/) specification while
167-
supports some uncommon versioning schemes. Working with Composer packages versions without `composer/semver` is a bit
168-
tricky.
158+
Despite the lie on [Composer FAQ](https://getcomposer.org/doc/faqs/which-version-numbering-system-does-composer-itself-use.md), the [fragmentary documentation](https://getcomposer.org/doc/articles/versions.md), and the deceitful package name `composer/semver`,
159+
Composer implements only a subset of [Semantic Versioning](https://semver.org/) specification while supports some uncommon versioning schemes.
160+
Working with Composer packages versions without `composer/semver` is a bit tricky.
169161

170162
*"A bit tricky"* is an understatement.
171163

@@ -220,16 +212,14 @@ curl -1sLf 'https://dl.cloudsmith.io/public/typisttech/oss/setup.deb.sh' | sudo
220212
sudo apt-get install composer-version
221213
```
222214

223-
Instead of the automatic setup script, you can manually configure the repository with the instructsions
224-
on [Cloudsmith](https://cloudsmith.io/~typisttech/repos/oss/setup/#formats-deb).
215+
Instead of the automatic setup script, you can manually configure the repository with the instructions on [Cloudsmith](https://cloudsmith.io/~typisttech/repos/oss/setup/#formats-deb).
225216

226217
### Manual `.deb` (Debian based distributions, for example: Ubuntu)
227218

228219
> [!WARNING]
229220
> If you install the `.deb` file manually, you have to take care of updating it by yourself.
230221
231-
Download the latest `.deb` file from [GitHub Releases](https://github.com/typisttech/composer-semver/releases/latest),
232-
or via [`gh`](https://cli.github.com/):
222+
Download the latest `.deb` file from [GitHub Releases](https://github.com/typisttech/composer-semver/releases/latest), or via [`gh`](https://cli.github.com/):
233223

234224
```sh
235225
# Both arm64 (aarch64) and amd64 (x86_64) architectures are available.
@@ -253,9 +243,7 @@ sudo dpkg -i composer-semver_linux_arm64.deb
253243
> [!WARNING]
254244
> If you install the binary manually, you have to take care of updating it by yourself.
255245
256-
Download the latest `.tar.gz` file
257-
from [GitHub Releases](https://github.com/typisttech/composer-semver/releases/latest), or via [
258-
`gh`](https://cli.github.com/):
246+
Download the latest `.tar.gz` file from [GitHub Releases](https://github.com/typisttech/composer-semver/releases/latest), or via [`gh`](https://cli.github.com/):
259247

260248
```sh
261249
# Both darwin (macOS) and linux operating systems are available.
@@ -286,17 +274,14 @@ mv composer-semver /usr/local/bin
286274

287275
## Credits
288276

289-
[`Composer SemVer`](https://github.com/typisttech/composer-semver) is a [Typist Tech](https://typist.tech)
290-
project and maintained by [Tang Rufus](https://x.com/TangRufus), freelance
291-
developer [for hire](https://typist.tech/contact/).
277+
[`Composer SemVer`](https://github.com/typisttech/composer-semver) is a [Typist Tech](https://typist.tech) project and maintained by [Tang Rufus](https://x.com/TangRufus), freelance developer [for hire](https://typist.tech/contact/).
292278

293-
Full list of contributors can be
294-
found [on GitHub](https://github.com/typisttech/composer-semver/graphs/contributors).
279+
Full list of contributors can be found [on GitHub](https://github.com/typisttech/composer-semver/graphs/contributors).
295280

296281
## Copyright and License
297282

298-
This project is a [free software](https://www.gnu.org/philosophy/free-sw.en.html) distributed under the terms of
299-
the MIT license. For the full license, see [LICENSE](./LICENSE).
283+
This project is a [free software](https://www.gnu.org/philosophy/free-sw.en.html) distributed under the terms of the MIT license.
284+
For the full license, see [LICENSE](./LICENSE).
300285

301286
## Contribute
302287

0 commit comments

Comments
 (0)