Skip to content

Commit f746373

Browse files
committed
Update README replacing EdgeDB with Gel.
1 parent 7561dd3 commit f746373

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

README.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Gel.Net](https://raw.githubusercontent.com/edgedb/edgedb-net/dev/branding/Banner.png)
1+
![Gel.Net](https://raw.githubusercontent.com/geldata/gel-net/dev/branding/Banner.png)
22

33
<p align="center">
44
<a href="https://www.nuget.org/packages/Gel.Net.Driver/">
@@ -7,22 +7,18 @@
77
<a href="https://www.nuget.org/packages/Gel.Net.Driver/">
88
<img src="https://img.shields.io/nuget/vpre/Gel.Net.Driver.svg?maxAge=2592000?style=plastic" alt="NuGet">
99
</a>
10-
<a href="https://github.com/edgedb/edgedb-net/actions/workflows/tests.yml">
11-
<img src="https://github.com/edgedb/edgedb-net/actions/workflows/tests.yml/badge.svg?branch=dev" alt="Tests">
10+
<a href="https://github.com/geldata/gel-net/actions/workflows/tests.yml">
11+
<img src="https://github.com/geldata/gel-net/actions/workflows/tests.yml/badge.svg?branch=dev" alt="Tests">
1212
</a>
1313
<a href="https://discord.gg/tM4EpAaeSq">
1414
<img src="https://discord.com/api/guilds/841451783728529451/widget.png" alt="Discord">
1515
</a>
16-
16+
1717
<p align="center">
18-
Gel.Net is the official .NET driver for the <a href="https://edgedb.com">Gel</a> database.
18+
Gel.Net is the official .NET driver for the <a href="https://www.geldata.com">Gel</a> database.
1919
</p>
2020
</p>
2121

22-
## Documentation
23-
24-
Documentation for the dotnet driver can be found [here](https://www.edgedb.com/docs/clients/dotnet).
25-
2622
## Installation
2723

2824
Gel.Net is distributed through the NuGet package manager.
@@ -38,9 +34,8 @@ $ dotnet add package Gel.Net.Driver
3834
### Creating a client
3935

4036
Clients are what allow your code to talk and interface with Gel. The
41-
[`GelClientPool`](https://www.edgedb.com/docs/clients/dotnet/api#EdgeDB.GelClientPool)
42-
class contains a pool of connections and numerous abstractions for executing
43-
queries with ease:
37+
`GelClientPool` class contains a pool of connections and numerous abstractions
38+
for executing queries with ease:
4439

4540
```cs
4641
using Gel;
@@ -51,11 +46,9 @@ var client = new GelClientPool();
5146
### Client configuration
5247

5348
`GelClientPool` will automatically determine how to connect to your Gel
54-
instance by resolving [Gel Projects](https://www.edgedb.com/docs/intro/projects).
49+
instance by resolving [Gel Projects](https://docs.geldata.com/learn/projects).
5550
For specifying custom connection arguments, considering checking out the
56-
[`GelConnection`](https://www.edgedb.com/docs/clients/dotnet/connection_parameters#GelConnection)
57-
class. Here's an example of using the [`.Create()`](https://www.edgedb.com/docs/clients/dotnet/connection_parameters#GelConnection.Create-Options?)
58-
method:
51+
`GelConnection` class. Here's an example of using the `.Create()` method:
5952

6053
```cs
6154
using Gel;
@@ -74,9 +67,10 @@ operations are performed asynchronously.
7467

7568
Queries are executed through the `GelClientPool` by using different helper
7669
methods. Your choice of method is dependent on the kind of query you're making,
77-
better known as [cardinality](https://www.edgedb.com/docs/clients/dotnet/index#cardinality-and-return-types).
70+
better known as [cardinality](https://docs.geldata.com/reference/edgeql/sets#everything-is-a-set).
7871

79-
Query helper methods will expect a generic `T` type which is the [.NET version of an Gel type](https://www.edgedb.com/docs/clients/dotnet/datatypes#datatypes):
72+
Query helper methods will expect a generic `T` type which is the .NET version
73+
of an Gel type:
8074

8175
```cs
8276
var result = await client.QueryAsync<long>("select 2 + 2"); // returns 4
@@ -97,7 +91,7 @@ check them out to see Gel.Net in action!
9791

9892
If you're building Gel.Net from source, you will need to download the
9993
[.NET 8 SDK](https://dotnet.microsoft.com/en-us/download).
100-
94+
10195
Once you have the SDK installed, you can then run `dotnet build` in the root
10296
directory of the project:
10397

0 commit comments

Comments
 (0)