Skip to content

Rename master branch to 1.x and update installation instructions #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SimonFrings merged 1 commit into from
Oct 19, 2022
Merged

Rename master branch to 1.x and update installation instructions #213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,14 @@

GraPHP is the mathematical graph/network library written in PHP.

> You're viewing the contents of the `master` development brach. Note that this
branch is subject to active development and will contain breaking changes
for the upcoming release. If you want to use the latest release version,
see also the `v0.9.x` release branch for more details.
> **Development version:** This branch contains the code for the upcoming 1.0 release.
> For the code of the current stable 0.9 release, check out the
> [`0.9.x` branch](https://github.com/graphp/graph/tree/0.9.x).
>
> The upcoming 1.0 release will be the way forward for this package.
> However, we will still actively support 0.9.x for those not yet
> on the latest version.
> See also [installation instructions](#install) for more details.

**Table of contents**

Expand Down Expand Up @@ -110,10 +114,11 @@ See [graphp/algorithms](https://github.com/graphp/algorithms) for more details.
The recommended way to install this library is [through Composer](https://getcomposer.org/).
[New to Composer?](https://getcomposer.org/doc/00-intro.md)

This will install the latest supported version:
Once released, this project will follow [SemVer](https://semver.org/).
At the moment, this will install the latest development version:

```bash
$ composer require clue/graph:^0.9.3
composer require graphp/graph:^1@dev
```

See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
Expand All @@ -132,13 +137,13 @@ To run the test suite, you first need to clone this repo and then install all
dependencies [through Composer](https://getcomposer.org/):

```bash
$ composer install
composer install
```

To run the test suite, go to the project root and run:

```bash
$ vendor/bin/phpunit
vendor/bin/phpunit
```

## Contributing
Expand Down