Skip to content

Commit e5b2802

Browse files
authored
Merge pull request #213 from clue-labs/rename
Rename `master` branch to `1.x` and update installation instructions
2 parents 41e73a5 + 87d5a2f commit e5b2802

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,14 @@
66

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

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

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

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

115120
```bash
116-
$ composer require clue/graph:^0.9.3
121+
composer require graphp/graph:^1@dev
117122
```
118123

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

134139
```bash
135-
$ composer install
140+
composer install
136141
```
137142

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

140145
```bash
141-
$ vendor/bin/phpunit
146+
vendor/bin/phpunit
142147
```
143148

144149
## Contributing

0 commit comments

Comments
 (0)