Skip to content

Commit

Permalink
Update README and CONTRIBUTING replacing Edgedb with Gel.
Browse files Browse the repository at this point in the history
  • Loading branch information
vpetrovykh authored and 1st1 committed Feb 22, 2025
1 parent ac5095e commit cd65d27
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 49 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
How to contribute to EdgeDB
===========================
How to contribute to Gel
========================

Thank you for contributing to EdgeDB! We love our open source community and
Thank you for contributing to Gel! We love our open source community and
want to foster a healthy contributor ecosystem.

To make sure the project can continue to improve quickly, we have a few
Expand Down Expand Up @@ -55,8 +55,8 @@ Contributing documentation
possible without being bogged down by other changes that require more
intensive review.

Please see EdgeDB's guide for `building documentation
<https://www.edgedb.com/docs/guides/contributing#writing-documentation>`_ from
Please see Gel's guide for `building documentation
<https://www.geldata.com/docs/guides/contributing#writing-documentation>`_ from
source.

Documentation style
Expand All @@ -69,8 +69,8 @@ Documentation style
that in favor of ``*param*``, in order to distinguish between parameter
references and inline code (which *should* be surrounded by double
backticks).
- **EdgeDB is singular.** Choose "EdgeDB is" over "EdgeDB are" and "EdgeDB
does" over "EdgeDB do."
- **Gel is singular.** Choose "Gel is" over "Gel are" and "Gel
does" over "Gel do."
- **Use American English spellings.** Choose "color" over "colour" and
"organize" over "organise."
- **Use the Oxford comma.** When delineating a series, place a comma between
Expand All @@ -81,7 +81,7 @@ Documentation style
like a computer science textbook. Sometimes that's necessary, but in most
cases, it isn't. Prioritize accuracy first and accessibility a close second.
- **Be careful using words that have a special meaning in the context of
EdgeDB.** In casual speech or writing, you might talk about a "set" of
something in a generic sense. Using the word this way in EdgeDB documentation
might easily be interpreted as a reference to EdgeDB's `sets <ref_eql_sets>`.
Gel.** In casual speech or writing, you might talk about a "set" of
something in a generic sense. Using the word this way in Gel documentation
might easily be interpreted as a reference to Gel's `sets <ref_eql_sets>`.
Avoid this kind of casual usage of key terms.
81 changes: 42 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
<p align="center">
<a href="https://www.edgedb.com">
<img src="https://www.edgedb.com/github_banner.png">
<a href="https://www.geldata.com">
<img src="https://www.geldata.com/github_banner.png">
</a>
</p>

<div align="center">
<h1>EdgeDB</h1>
<a href="https://github.com/edgedb/edgedb" rel="nofollow">
<img src="https://img.shields.io/github/stars/edgedb/edgedb" alt="Stars">
<h1>Gel</h1>
<a href="https://github.com/geldata/gel" rel="nofollow">
<img src="https://img.shields.io/github/stars/geldata/gel" alt="Stars">
</a>
<a href="https://github.com/edgedb/edgedb/actions">
<img src="https://github.com/edgedb/edgedb/workflows/Tests/badge.svg?event=push&branch=master" />
<a href="https://github.com/geldata/gel/actions">
<img src="https://github.com/geldata/gel/workflows/Tests/badge.svg?event=push&branch=master" />
</a>
<a href="https://github.com/edgedb/edgedb/blob/master/LICENSE">
<a href="https://github.com/geldata/gel/blob/master/LICENSE">
<img alt="license" src="https://img.shields.io/badge/license-Apache%202.0-blue" />
</a>
<a href="https://discord.gg/umUueND6ag">
<img alt="discord" src="https://img.shields.io/discord/841451783728529451?color=5865F2&label=discord&logo=discord&logoColor=8a9095">
</a>
<br />
<br />
<a href="https://www.edgedb.com/docs/guides/quickstart">Quickstart</a>
<a href="https://www.geldata.com/docs/guides/quickstart">Quickstart</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://www.edgedb.com">Website</a>
<a href="https://www.geldata.com">Website</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://www.edgedb.com/docs">Docs</a>
<a href="https://www.geldata.com/docs">Docs</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://www.edgedb.com/tutorial">Playground</a>
<a href="https://www.geldata.com/tutorial">Playground</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://www.edgedb.com/blog">Blog</a>
<a href="https://www.geldata.com/blog">Blog</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://discord.gg/umUueND6ag">Discord</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://twitter.com/edgedatabase">Twitter</a>
<a href="https://twitter.com/usegel">Twitter</a>
<br />

</div>
Expand All @@ -42,9 +42,9 @@

<br/>
<div align="center">
<h2>What is EdgeDB?</h2>
<h2>What is Gel?</h2>
<p style="max-width: 450px;">
EdgeDB is a new kind of database
Gel is a new kind of database
<br/>
that takes the best parts of
<br/>
Expand All @@ -68,7 +68,7 @@ read, write, and understand.

Forget foreign keys; tabular data modeling is a relic of an older age, and it
[isn't compatible](https://en.wikipedia.org/wiki/Object%E2%80%93relational_impedance_mismatch)
with modern languages. Instead, EdgeDB thinks about schema the same way you do:
with modern languages. Instead, Gel thinks about schema the same way you do:
as **object types** containing **properties** connected by **links**.

```esdl
Expand All @@ -82,11 +82,11 @@ type Movie {
}
```

This example is intentionally simple, but EdgeDB supports everything you'd
This example is intentionally simple, but Gel supports everything you'd
expect from your database: a strict type system, indexes, constraints, computed
properties, stored procedures...the list goes on. Plus it gives you some shiny
new features too: link properties, schema mixins, and best-in-class JSON
support. Read the [schema docs](https://www.edgedb.com/docs/datamodel/index)
support. Read the [schema docs](https://www.geldata.com/docs/datamodel/index)
for details.

<!-- ### Objects, not rows. ❄️ -->
Expand All @@ -97,7 +97,7 @@ for details.
</div>
<br/>

EdgeDB's super-powered query language EdgeQL is designed as a ground-up
Gel's super-powered query language EdgeQL is designed as a ground-up
redesign of SQL. EdgeQL queries produce rich, structured objects, not flat
lists of rows. Deeply fetching related objects is painless...bye, bye, JOINs.

Expand Down Expand Up @@ -131,7 +131,7 @@ insert Movie {

There's a lot more to EdgeQL: a comprehensive standard library, computed
properties, polymorphic queries, `with` blocks, transactions, and much more.
Read the [EdgeQL docs](https://www.edgedb.com/docs/edgeql/index) for the full
Read the [EdgeQL docs](https://www.geldata.com/docs/edgeql/index) for the full
picture.

<br/>
Expand All @@ -140,22 +140,22 @@ picture.
</div>
<br/>

While EdgeDB solves the same problems as ORM libraries, it's so much more. It's
While Gel solves the same problems as ORM libraries, it's so much more. It's
a full-fledged database with a
[powerful and elegant query language](https://www.edgedb.com/docs/edgeql/index), a
[migrations system](https://www.edgedb.com/docs/guides/migrations/index), a
[suite of client libraries](https://www.edgedb.com/docs/clients/index) in
[powerful and elegant query language](https://www.geldata.com/docs/edgeql/index), a
[migrations system](https://www.geldata.com/docs/guides/migrations/index), a
[suite of client libraries](https://www.geldata.com/docs/clients/index) in
different languages, a
[command line tool](https://www.edgedb.com/docs/cli/index), and—coming soon—a
[command line tool](https://www.geldata.com/docs/cli/index), and—coming soon—a
cloud hosting platform. The goal is to rethink every aspect of how developers
model, migrate, manage, and query their database.

Here's a taste-test of EdgeDB's next-level developer experience: you can
Here's a taste-test of Gel's next-level developer experience: you can
install our CLI, spin up an instance, and open an interactive EdgeQL shell with
just three commands.

```
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.edgedb.com | sh
$ curl --proto '=https' --tlsv1.2 -sSf https://geldata.com/sh | sh
$ edgedb project init
$ edgedb
edgedb> select "Hello world!"
Expand All @@ -164,43 +164,46 @@ edgedb> select "Hello world!"
Windows users: use this Powershell command to install the CLI.

```
PS> iwr https://ps1.edgedb.com -useb | iex
PS> iwr https://geldata.com/ps1 -useb | iex
```

<br />

## Get started

To start learning about EdgeDB, check out the following resources:
To start learning about Gel, check out the following resources:

- **[The quickstart](https://www.edgedb.com/docs/guides/quickstart)**. If
- **[The quickstart](https://www.geldata.com/docs/guides/quickstart)**. If
you're just starting out, the 10-minute quickstart guide is the fastest way
to get up and running.
- **[EdgeDB Cloud 🌤️](https://www.edgedb.com/cloud)**. The best
most effortless way to host your EdgeDB database in the cloud.
- **[The interactive tutorial](https://www.edgedb.com/tutorial)**. For a
- **[Gel Cloud 🌤️](https://www.geldata.com/cloud)**. The best
most effortless way to host your Gel database in the cloud.
- **[The interactive tutorial](https://www.geldata.com/tutorial)**. For a
structured deep-dive into the EdgeQL query language, try the web-based
tutorial— no need to install anything.
<!-- The e-book needs to be converted to Gel
- **[The e-book](https://www.edgedb.com/easy-edgedb)**. For the most
comprehensive walkthrough of EdgeDB concepts, check out our illustrated
e-book [Easy EdgeDB](https://www.edgedb.com/easy-edgedb). It's designed to
walk a total beginner through EdgeDB in its entirety, from the basics through
advanced concepts.
-->
- **The docs.** Jump straight into the docs for
[schema modeling](https://www.edgedb.com/docs/datamodel/index) or
[EdgeQL](https://www.edgedb.com/docs/edgeql/index)!
[schema modeling](https://www.geldata.com/docs/datamodel/index) or
[EdgeQL](https://www.geldata.com/docs/edgeql/index)!

<br />

## Contributing

PRs are always welcome! To get started, follow
[this guide](https://www.edgedb.com/docs/internals/dev) to build EdgeDB from
[this guide](https://www.geldata.com/docs/internals/dev) to build Gel from
source on your local machine.

[File an issue 👉](https://github.com/edgedb/edgedb/issues/new/choose)
[File an issue 👉](https://github.com/geldata/gel/issues/new/choose)
<br />
[Start a Discussion 👉](https://github.com/edgedb/edgedb/discussions/new)
[Start a Discussion 👉](https://github.com/geldata/gel/discussions/new)
<br />
[Join the discord 👉](https://discord.gg/umUueND6ag)

Expand Down

0 comments on commit cd65d27

Please sign in to comment.