Skip to content

Commit

Permalink
docs: add installation instructions for next branch
Browse files Browse the repository at this point in the history
  • Loading branch information
clemlatz committed Mar 8, 2022
1 parent e17c717 commit d57d13c
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# biblys/isbn
# biblys/isbn 3.0 beta

[![tests](https://github.com/biblys/isbn/actions/workflows/tests.yml/badge.svg)](https://github.com/biblys/isbn/actions/workflows/tests.yml)
[![Latest Stable Version](https://poser.pugx.org/biblys/isbn/v/stable)](https://packagist.org/packages/biblys/isbn)
[![Total Downloads](https://poser.pugx.org/biblys/isbn/downloads)](https://packagist.org/packages/biblys/isbn)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/biblys/isbn)

:warning: The `next` branch holds the code for the next major version of the library.
It is experimental, adds support for PHP 8.0 but removes deprecated code. It is not considered stable.
For a stable version, use the [main branch](https://github.com/biblys/isbn/tree/main) releases instead.

biblys/isbn can be used to:

- [validate](#validate) a string against the ISBN-10, ISBN-13 and EAN-13 formats
Expand All @@ -16,15 +20,12 @@ biblys/isbn can be used to:

## Installation

### Requirements
- PHP 7.x

If you need to support PHP 8, see [the next branch](https://github.com/biblys/isbn/blob/next/README.md).
Requirements: PHP 7.1 or above

### Install with composer
Install with composer:

```console
composer require biblys/isbn:^2.5.0
composer require biblys/isbn:dev-next
```

## Usage
Expand Down

0 comments on commit d57d13c

Please sign in to comment.