Skip to content

Commit 8d95b90

Browse files
committed
Rename master branch to 0.9.x and update installation instructions
1 parent ef65a9e commit 8d95b90

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,24 @@
44

55
Common mathematical graph algorithms implemented in PHP
66

7-
> You're viewing the contents of the `master` development brach. Note that this
8-
branch is subject to active development and will contain breaking changes
9-
for the upcoming release. If you want to use the latest release version,
10-
see also the `v0.8.x` release branch for more details.
11-
12-
> Note: This project is in beta stage! Feel free to report any issues you encounter.
7+
> **Development version:** This branch contains the code for the upcoming
8+
> version 0.9. For the code of the current stable version 0.8, check out the
9+
> [`0.8.x` branch](https://github.com/graphp/algorithms/tree/0.8.x).
10+
>
11+
> The upcoming version 0.9 will be the way forward for this package. However,
12+
> we will still actively support version 0.8 for those not yet on the latest
13+
> version. See also [installation instructions](#install) for more details.
1314
1415
## Install
1516

16-
The recommended way to install this library is [through Composer](https://getcomposer.org).
17+
The recommended way to install this library is [through Composer](https://getcomposer.org/).
1718
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
1819

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

2123
```bash
22-
$ composer require graphp/algorithms:^0.8.2
24+
composer require graphp/algorithms:^0.9@dev
2325
```
2426

2527
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
@@ -32,18 +34,18 @@ It's *highly recommended to use PHP 7+* for this project.
3234
## Tests
3335

3436
To run the test suite, you first need to clone this repo and then install all
35-
dependencies [through Composer](https://getcomposer.org):
37+
dependencies [through Composer](https://getcomposer.org/):
3638

3739
```bash
38-
$ composer install
40+
composer install
3941
```
4042

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

4345
```bash
44-
$ php vendor/bin/phpunit
46+
vendor/bin/phpunit
4547
```
4648

4749
## License
4850

49-
Released under the terms of the permissive [MIT license](http://opensource.org/licenses/MIT).
51+
This project is released under the permissive [MIT license](LICENSE).

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
],
1313
"require": {
1414
"php": ">=5.3",
15-
"graphp/graph": "dev-master#fb198e4 as 1.0.0"
15+
"graphp/graph": "1.x-dev#fb198e4 as 1.0.0"
1616
},
1717
"require-dev": {
1818
"phpunit/phpunit": "^9.3 || ^5.7 || ^4.8.35"

0 commit comments

Comments
 (0)