Skip to content

Commit b66f8ae

Browse files
authored
update README (#170)
1 parent 991022a commit b66f8ae

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22

33
Official Dgraph Go client which communicates with the server using [gRPC](https://grpc.io/).
44

5-
Before using this client, we highly recommend that you go through [dgraph.io/tour](https://docs.dgraph.io) and
6-
[dgraph.io/docs](https://tour.dgraph.io) to understand how to run and work with Dgraph.
5+
Before using this client, we highly recommend that you go through [dgraph.io/tour] and
6+
[dgraph.io/docs] to understand how to run and work with Dgraph.
7+
8+
[docs.dgraph.io]:https://dgraph.io/docs
9+
[tour.dgraph.io]:https://dgraph.io/tour
710

811
**Use [Github Issues](https://github.com/dgraph-io/dgo/issues) for reporting issues about this repository.**
912

@@ -45,6 +48,9 @@ Note: One of the most important API breakages from dgo v1 to v2 is in
4548
the function `dgo.Txn.Mutate`. This function returns an `*api.Assigned`
4649
value in v1 but an `*api.Response` in v2.
4750

51+
Note: We have removed functions `DialSlashEndpoint`, `DialSlashGraphQLEndpoint` from `v230.0.0`.
52+
Please use `DialCloud` instead.
53+
4854
Note: There is no breaking API change from v2 to v200 but we have decided
4955
to follow the [CalVer Versioning Scheme](https://dgraph.io/blog/post/dgraph-calendar-versioning).
5056

@@ -349,8 +355,8 @@ dgraphClient := dgo.NewDgraphClient(api.NewDgraphClient(conn))
349355

350356
### Running tests
351357

352-
Make sure you have `dgraph` installed in your GOPATH before you run the tests.
353-
The dgo test suite requires that a Dgraph cluster with ACL enabled be running locally.
358+
Make sure you have `dgraph` installed in your GOPATH before you run the tests.
359+
The dgo test suite requires that a Dgraph cluster with ACL enabled be running locally.
354360
To start such a cluster, you may use the docker compose file located in the testing directory `t`.
355361

356362
```sh

0 commit comments

Comments
 (0)