Skip to content

Commit 6a120e7

Browse files
authored
Update docs (#98)
1 parent 9fc863f commit 6a120e7

File tree

70 files changed

+1628
-1045
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+1628
-1045
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ A clear and concise description of what you expected to happen. If applicable, a
2222
**Versions (please complete the following information):**
2323

2424
<!--
25-
For EdgeDB Version: run `edgedb query 'select sys::get_version_as_str()'` from your project directory (or run `select sys::get_version_as_str();` in the EdgeDB interactive shell).
26-
For EdgeDB CLI version: Run `edgedb --version` from anywhere
27-
For `edgedb-net` version: Run `dotnet list package` from your project directory and look for "EdgeDB.Net.Driver", or find the version number in NuGet's "Installed" tab.
25+
For Gel Version: run `gel query 'select sys::get_version_as_str()'` from your project directory (or run `select sys::get_version_as_str();` in the Gel interactive shell).
26+
For Gel CLI version: Run `gel --version` from anywhere
27+
For `gel-net` version: Run `dotnet list package` from your project directory and look for "EdgeDB.Net.Driver", or find the version number in NuGet's "Installed" tab.
2828
For .NET version: dotnet --version
2929
-->
3030

3131
- OS:
32-
- EdgeDB version:
33-
- EdgeDB CLI version:
34-
- `edgedb-net` version:
32+
- Gel version:
33+
- Gel CLI version:
34+
- `gel-net` version:
3535
- .NET version:
3636

3737
**Additional context**
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
name: Feature request
3-
about: Suggest a feature for EdgeDB.Net
3+
about: Suggest a feature for Gel.Net
44

55
---
66

77
<!-- Please search existing issues to avoid creating duplicates. -->
88

9-
<!-- Describe the feature you'd like to see implemented in EdgeDB.Net. -->
9+
<!-- Describe the feature you'd like to see implemented in Gel.Net. -->

.github/workflows/build-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
run: dotnet build --no-restore
2525

2626
- name: Doc generation
27-
run: dotnet run --project ./tools/EdgeDB.DocGenerator/ -- $GITHUB_WORKSPACE
27+
run: dotnet run --project ./tools/Gel.DocGenerator/ -- $GITHUB_WORKSPACE
2828

2929
- name: Set git status Env
3030
id: gh-status-check

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
EdgeDB.Net is an open-source project, and we appreciate any and all
3+
Gel.Net is an open-source project, and we appreciate any and all
44
contributions made by our community. However, please conform to the
55
following guidelines when possible:
66

Gel.Net.targets

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
<PropertyGroup>
33
<VersionPrefix>1.4.0</VersionPrefix>
44
<LangVersion>latest</LangVersion>
5-
<Authors>EdgeDB.Net Contributors</Authors>
6-
<PackageTags>edgedb;db;database</PackageTags>
5+
<Authors>Gel.Net Contributors</Authors>
6+
<PackageTags>edgedb;gel;db;database</PackageTags>
77
<PackageProjectUrl>https://github.com/edgedb/edgedb-net</PackageProjectUrl>
88
<PackageLicenseExpression>MIT</PackageLicenseExpression>
99
<PackageIcon>PackageLogo.png</PackageIcon>

README.md

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

33
<p align="center">
44
<a href="https://www.nuget.org/packages/EdgeDB.Net.Driver/">
@@ -15,7 +15,7 @@
1515
</a>
1616

1717
<p align="center">
18-
EdgeDB.Net is the official .NET driver for the <a href="https://edgedb.com">EdgeDB</a> database.
18+
Gel.Net is the official .NET driver for the <a href="https://edgedb.com">Gel</a> database.
1919
</p>
2020
</p>
2121

@@ -25,7 +25,7 @@ Documentation for the dotnet driver can be found [here](https://www.edgedb.com/d
2525

2626
## Installation
2727

28-
EdgeDB.Net is distributed through the NuGet package manager.
28+
Gel.Net is distributed through the NuGet package manager.
2929
We recommend using the `dotnet` command or NuGet package manager in Visual
3030
Studio:
3131

@@ -37,64 +37,66 @@ $ dotnet add package EdgeDB.Net.Driver
3737

3838
### Creating a client
3939

40-
Clients are what allow your code to talk and interface with EdgeDB. The
41-
[`EdgeDBClient`](https://www.edgedb.com/docs/clients/dotnet/api#EdgeDB.EdgeDBClient)
40+
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)
4242
class contains a pool of connections and numerous abstractions for executing
4343
queries with ease:
4444

4545
```cs
46-
using EdgeDB;
46+
using Gel;
4747

48-
var client = new EdgeDBClient();
48+
var client = new GelClientPool();
4949
```
5050

5151
### Client configuration
5252

53-
`EdgeDBClient` will automatically determine how to connect to your EdgeDB
54-
instance by resolving [EdgeDB Projects](https://www.edgedb.com/docs/intro/projects).
53+
`GelClientPool` will automatically determine how to connect to your Gel
54+
instance by resolving [Gel Projects](https://www.edgedb.com/docs/intro/projects).
5555
For specifying custom connection arguments, considering checking out the
56-
[`EdgeDBConnection`](https://www.edgedb.com/docs/clients/dotnet/connection_parameters#EdgeDBConnection)
57-
class. Here's an example of using the [`.Parse()`](https://www.edgedb.com/docs/clients/dotnet/connection_parameters#EdgeDBConnection.Parse-string?-string?-Action_EdgeDBConnection_?-bool)
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?)
5858
method:
5959

6060
```cs
61-
using EdgeDB;
61+
using Gel;
6262

63-
var connection = EdgeDBConnection.Parse("edgedb://user:password@localhost:5656/mydb");
64-
var client = new EdgeDBClient(connection);
63+
var connection = GelConnection.Create(
64+
new GelConnection.Options(){dsn="gel://user:password@localhost:5656/mybranch"}
65+
);
66+
var client = new GelClientPool(connection);
6567
```
6668

6769
### Executing queries
6870

69-
**Note**: EdgeDB.Net is a fully asynchronous driver, and as such, all I/O
71+
**Note**: Gel.Net is a fully asynchronous driver, and as such, all I/O
7072
operations are performed asynchronously.
7173

7274

73-
Queries are executed through the `EdgeDBClient` by using different helper
75+
Queries are executed through the `GelClientPool` by using different helper
7476
methods. Your choice of method is dependent on the kind of query you're making,
7577
better known as [cardinality](https://www.edgedb.com/docs/clients/dotnet/index#cardinality-and-return-types).
7678

77-
Query helper methods will expect a generic `T` type which is the [.NET version of an EdgeDB type](https://www.edgedb.com/docs/clients/dotnet/datatypes#datatypes):
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):
7880

7981
```cs
8082
var result = await client.QueryAsync<long>("select 2 + 2"); // returns 4
8183
```
8284

8385
## Contributing
8486

85-
We openly welcome and accept contributions to EdgeDB.Net! Before writing a
87+
We openly welcome and accept contributions to Gel.Net! Before writing a
8688
GitHub Issue or Pull Request, please see our [contribution requirements](CONTRIBUTING.md).
8789

8890
## Examples
8991

9092
This repository contains a list of [working examples](examples),
91-
check them out to see EdgeDB.Net in action!
93+
check them out to see Gel.Net in action!
9294

9395

9496
## Compiling
9597

96-
If you're building EdgeDB.Net from source, you will need to download the
97-
[.NET 6 SDK](https://dotnet.microsoft.com/en-us/download).
98+
If you're building Gel.Net from source, you will need to download the
99+
[.NET 8 SDK](https://dotnet.microsoft.com/en-us/download).
98100

99101
Once you have the SDK installed, you can then run `dotnet build` in the root
100102
directory of the project:

0 commit comments

Comments
 (0)