Skip to content

Commit e41d661

Browse files
author
twalder-docnet
committed
README updates for 2.0 release
1 parent affbbb8 commit e41d661

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,6 @@
77

88
This library is intended to make it easier for you to get started with and to use Datastore in your applications.
99

10-
## 2.0 BETA 2 ##
11-
12-
**Please note, this 2.0-series (dev-master) is in BETA and not suitable (yet) for production**
13-
14-
The documentation is not yet fully representative of 2.x implementation.
15-
1610
## Table of Contents ##
1711

1812
- [Examples](#examples)
@@ -104,6 +98,7 @@ New features in 2.0 include
10498
* **Local development** - Using the Protocol Buffers allows us to access the development server Datastore
10599
* **Local GQL support** - By default, the local development server does not support GQL. I've included a basic GQL parser that makes this work.
106100
* **Data Migrations** - leverage multiple Gateways to ship data between local and live Datastore
101+
* **Contention Exceptions** - standardised Exception for handling Datastore transaction contention`
107102
* **Unit tests**
108103
* Optional drop-in JSON API Gateway for remote or non-AppEngine environments (this was the only Gateway in 1.x)
109104

@@ -136,9 +131,13 @@ If you want to use the JSON API from remote or non-App Engine environments, you
136131

137132
To install using Composer, use this require line, for production
138133

134+
`"tomwalder/php-gds": "v2.0.0"`
135+
136+
For older, version 1 series
137+
139138
`"tomwalder/php-gds": "v1.2.1"`
140139

141-
and for bleeding-edge features, 2.0 dev-master
140+
and for bleeding-edge features, dev-master
142141

143142
`"tomwalder/php-gds": "dev-master"`
144143

@@ -342,6 +341,8 @@ $obj_store->upsert($obj_entity);
342341
$obj_store->delete($obj_entity);
343342
```
344343

344+
Watch out for `GDS\Exception\Contention` exceptions - they should be thrown by the library if you manage to hit Datastore contention locally in development or through the live Gateways.
345+
345346
## Custom Entity Classes and Stores ##
346347

347348
Whilst you can use the `GDS\Entity` and `GDS\Store` classes directly, as per the examples above, you may find it useful to extend one or the other.

0 commit comments

Comments
 (0)