Skip to content

Commit f650ad1

Browse files
committed
Update readme to require users use 0.1 instead of dev-master
1 parent e92084f commit f650ad1

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
# ConvertKit SDK PHP
2+
23
ConvertKit's official PHP SDK
34

45
### Installation
56

6-
#### Standard installation
7+
#### Standard Installation
78

89
1. Download or clone this repository
910
2. Run `composer install`
1011
3. Add `./vendor/autoload.php` to your project
1112

12-
#### Installation with package manager
13+
#### Installation with Package Manager
1314

1415
If your project uses [Composer](https://getcomposer.org/), you can install the ConvertKitSDK-PHP package as a composer package. This allows you to have this project as a dependency without the ConvertKitSDK-PHP files being checked into your source code.
1516

1617
```shell
17-
composer require convertkit/convertkitapi:dev-master
18+
composer require convertkit/convertkitapi:0.1
1819
```
1920

20-
Please note that since ConvertKitSDK-PHP is not yet versioned, your project will always download the latest files from master every time you run `composer install` which may subject you to breaking changes in the future.
21+
**If you previously use or rely on `dev-master`, please use the `0.1` release to maintain compatibility with no breaking changes.**
22+
23+
This package is now versioned, and `1.0` will introduce breaking changes to bring this package up to date with coding standards, PHP versions and third party library versions.
2124

2225
### Usage
2326

0 commit comments

Comments
 (0)