Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix icon paths on markdown files #2012

Merged
merged 2 commits into from
May 19, 2023
Merged

Fix icon paths on markdown files #2012

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f713c1
Fix icon paths on markdown files
roynrishingha May 18, 2023
0de0ab8
fix icon path
roynrishingha May 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1><img height="25" src="/img/love.svg">&nbsp;&nbsp;Contributor Covenant Code of Conduct</h1>
<h1><img height="25" src="./img/love.svg">&nbsp;&nbsp;Contributor Covenant Code of Conduct</h1>

## Our Pledge

Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1><img height="25" src="/img/contributing.svg">&nbsp;&nbsp;Contributing</h1>
<h1><img height="25" src="./img/contributing.svg">&nbsp;&nbsp;Contributing</h1>

We would &nbsp;<img width="15" src="/img/love.svg">&nbsp; for you to contribute to SurrealDB and help make it better! We want contributing to SurrealDB to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including features, bugfixes, and documentation changes, as well as updates and tweaks, blog posts, workshops, and everything else.
We would &nbsp;<img width="15" src="./img/love.svg">&nbsp; for you to contribute to SurrealDB and help make it better! We want contributing to SurrealDB to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including features, bugfixes, and documentation changes, as well as updates and tweaks, blog posts, workshops, and everything else.

## How to start

Expand Down Expand Up @@ -91,7 +91,7 @@ Please avoid introducing new dependencies to SurrealDB without consulting the te

## Introducing new features

We would &nbsp;<img width="15" src="/img/love.svg">&nbsp; you to contribute to SurrealDB, but we would also like to make sure SurrealDB is as great as possible and loyal to its vision and mission statement. For us to find the right balance, please open a question on [GitHub discussions](https://github.com/surrealdb/surrealdb/discussions) with any ideas before introducing a new pull request. This will allow the SurrealDB community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision.
We would &nbsp;<img width="15" src="./img/love.svg">&nbsp; you to contribute to SurrealDB, but we would also like to make sure SurrealDB is as great as possible and loyal to its vision and mission statement. For us to find the right balance, please open a question on [GitHub discussions](https://github.com/surrealdb/surrealdb/discussions) with any ideas before introducing a new pull request. This will allow the SurrealDB community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision.

This is also important for the SurrealDB lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/surrealdb/rfcs).

Expand Down
112 changes: 55 additions & 57 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
<br>

<p align="center">
<img width="300" src="/img/icon.png" alt="SurrealDB Icon">
<img width="300" src="./img/icon.png" alt="SurrealDB Icon">
</p>

<br>

<p align="center">
<!-- <p align="center">
<a href="https://surrealdb.com#gh-dark-mode-only" target="_blank">
<img width="300" src="/img/white/logo.svg" alt="SurrealDB Logo">
</a>
<a href="https://surrealdb.com#gh-light-mode-only" target="_blank">
<img width="300" src="/img/black/logo.svg" alt="SurrealDB Logo">
</a>
</p>
</p> -->

<h3 align="center">
<a href="https://surrealdb.com#gh-dark-mode-only" target="_blank">
<!-- <a href="https://surrealdb.com#gh-dark-mode-only" target="_blank">
<img src="/img/white/text.svg" height="15" alt="SurrealDB">
</a>
<a href="https://surrealdb.com#gh-light-mode-only" target="_blank">
<img src="/img/black/text.svg" height="15" alt="SurrealDB">
</a>
is the ultimate cloud <br> database for tomorrow's applications
</a> -->
SurrealDB is the ultimate cloud <br> database for tomorrow's applications
</h3>

<h3 align="center">Develop easier. &nbsp; Build faster. &nbsp; Scale quicker.</h3>
Expand Down Expand Up @@ -53,7 +53,7 @@
<a href="https://www.linkedin.com/company/surrealdb/"><img src="https://img.shields.io/badge/linkedin-connect_with_us-0a66c2.svg?style=flat-square"></a>
</p>

<p align="center">
<!-- <p align="center">
<a href="https://surrealdb.com/blog"><img height="25" src="/img/social/blog.svg" alt="Blog"></a>
&nbsp;
<a href="https://github.com/surrealdb/surrealdb"><img height="25" src="/img/social/github.svg" alt="Github "></a>
Expand All @@ -70,11 +70,11 @@
&nbsp;
<a href="https://stackoverflow.com/questions/tagged/surrealdb"><img height="25" src="/img/social/stack-overflow.svg" alt="StackOverflow"></a>

</p>
</p> -->

<br>

<h2><img height="20" src="/img/whatissurreal.svg">&nbsp;&nbsp;What is SurrealDB?</h2>
<h2><img height="20" src="./img/whatissurreal.svg">&nbsp;&nbsp;What is SurrealDB?</h2>

SurrealDB is an end-to-end cloud-native database designed for modern applications, including web, mobile, serverless, Jamstack, backend, and traditional applications. With SurrealDB, you can simplify your database and API infrastructure, reduce development time, and build secure, performant apps quickly and cost-effectively.

Expand All @@ -88,38 +88,28 @@ SurrealDB is an end-to-end cloud-native database designed for modern application

View the [features](https://surrealdb.com/features), the latest [releases](https://surrealdb.com/releases), the product [roadmap](https://surrealdb.com/roadmap), and [documentation](https://surrealdb.com/docs).

<img src="/img/interface.png">

<h2><img height="20" src="/img/contents.svg">&nbsp;&nbsp;Contents</h2>

- [Features](#features)
- [Documentation](#documentation)
- [Installation](#installation)
- [Install on macOS](#install-on-macos)
- [Install on Linux](#install-on-linux)
- [Install on Windows](#install-on-windows)
- [Run using Docker](#run-using-docker)
- [Getting started](#getting-started)
- [Client side apps](#client-side-apps)
- [Server side code](#server-side-code)
- [Quick look](#quick-look)
- [Why SurrealDB](#why-surrealdb)
<!-- <img src="/img/interface.png"> -->

<h2><img height="20" src="./img/contents.svg">&nbsp;&nbsp;Contents</h2>

- [Install on macOS](#install-on-macos)
- [Install on Linux](#install-on-linux)
- [Install on Windows](#install-on-windows)
- [Run using Docker](#run-using-docker)
- [Client side apps](#client-side-apps)
- [Server side code](#server-side-code)
- [Database, API, and permissions](#database-api-and-permissions)
- [Tables, documents, and graph](#tables-documents-and-graph)
- [Advanced inter-document relations](#advanced-inter-document-relations-and-analysis-no-joins-no-pain)
- [Simple schema definition](#simple-schema-definition-for-frontend-and-backend-development)
- [Connect directly from web-browsers](#connect-and-query-directly-from-web-browsers-and-client-devices)
- [Multiple different query methods](#query-the-database-with-the-tools-you-want)
- [Realtime live queries and data changes](#realtime-live-queries-and-data-changes-direct-to-application)
- [Scale effortlessly for high-availability](#scale-effortlessly-to-hundreds-of-nodes-for-high-availability-and-scalability)
- [Extend your database with JavaScript](#extend-your-database-with-javascript-functions)
- [Designed to be embedded or in the cloud](#designed-to-be-embedded-or-to-run-distributed-in-the-cloud)
- [Community](#community)
- [Contributing](#contributing)
- [Security](#security)
- [License](#license)

<h2><img height="20" src="/img/features.svg">&nbsp;&nbsp;Features</h2>
- [Advanced inter-document relations and analysis. No JOINs. No pain.](#advanced-inter-document-relations-and-analysis-no-joins-no-pain)
- [Simple schema definition for frontend and backend development](#simple-schema-definition-for-frontend-and-backend-development)
- [Connect and query directly from web-browsers and client devices](#connect-and-query-directly-from-web-browsers-and-client-devices)
- [Query the database with the tools you want](#query-the-database-with-the-tools-you-want)
- [Realtime live queries and data changes direct to application](#realtime-live-queries-and-data-changes-direct-to-application)
- [Scale effortlessly to hundreds of nodes for high-availability and scalability](#scale-effortlessly-to-hundreds-of-nodes-for-high-availability-and-scalability)
- [Extend your database with JavaScript functions](#extend-your-database-with-javascript-functions)
- [Designed to be embedded or to run distributed in the cloud](#designed-to-be-embedded-or-to-run-distributed-in-the-cloud)

<h2><img height="20" src="./img/features.svg">&nbsp;&nbsp;Features</h2>

- [x] Database server, or embedded library
- [x] Multi-row, multi-table ACID transactions
Expand All @@ -133,27 +123,31 @@ View the [features](https://surrealdb.com/features), the latest [releases](https
- [x] Connect and query directly from web-browsers and client devices
- [x] Use embedded JavaScript functions for custom advanced functionality

<h2><img height="20" src="/img/documentation.svg">&nbsp;&nbsp;Documentation</h2>
<h2><img height="20" src="./img/documentation.svg">&nbsp;&nbsp;Documentation</h2>

For guidance on installation, development, deployment, and administration, see our [documentation](https://surrealdb.com/docs).

<h2><img height="20" src="/img/installation.svg">&nbsp;&nbsp;Installation</h2>
<h2><img height="20" src="./img/installation.svg">&nbsp;&nbsp;Installation</h2>

SurrealDB is designed to be simple to install and simple to run - using just one command from your terminal. In addition to traditional installation, SurrealDB can be installed and run with HomeBrew, Docker, or using any other container orchestration tool such as Docker Compose, Docker Swarm, Rancher, or in Kubernetes.

<h4><a href="https://surrealdb.com/install#gh-dark-mode-only"><img width="20" src="/img/white/apple.svg"></a><a href="https://surrealdb.com/install#gh-light-mode-only"><img width="20" src="/img/black/apple.svg"></a>
<!-- <h4><a href="https://surrealdb.com/install#gh-dark-mode-only"><img width="20" src="/img/white/apple.svg"></a><a href="https://surrealdb.com/install#gh-light-mode-only"><img width="20" src="/img/black/apple.svg"></a>
&nbsp;Install on macOS
</h4>
</h4> -->

### Install on macOS

The quickest way to get going with SurrealDB on macOS is to use Homebrew. This will install both the command-line tools, and the SurrealDB server as a single executable. If you don't use Homebrew, follow the instructions for Linux below to install SurrealDB.

```bash
brew install surrealdb/tap/surreal
```

<h4><a href="https://surrealdb.com/install#gh-dark-mode-only"><img width="20" src="/img/white/linux.svg"></a><a href="https://surrealdb.com/install#gh-light-mode-only"><img width="20" src="/img/black/linux.svg"></a>
<!-- <h4><a href="https://surrealdb.com/install#gh-dark-mode-only"><img width="20" src="/img/white/linux.svg"></a><a href="https://surrealdb.com/install#gh-light-mode-only"><img width="20" src="/img/black/linux.svg"></a>
&nbsp;Install on Linux
</h4>
</h4> -->

### Install on Linux

The easiest and preferred way to get going with SurrealDB on Unix operating systems is to install and use the SurrealDB command-line tool. Run the following command in your terminal and follow the on-screen instructions.

Expand All @@ -167,19 +161,23 @@ If you want a binary newer than what's currently released, you can install the n
curl --proto '=https' --tlsv1.2 -sSf https://install.surrealdb.com | sh -s -- --nightly
```

<h4><a href="https://surrealdb.com/install#gh-dark-mode-only"><img width="20" src="/img/white/windows.svg"></a><a href="https://surrealdb.com/install#gh-light-mode-only"><img width="20" src="/img/black/windows.svg"></a>
<!-- <h4><a href="https://surrealdb.com/install#gh-dark-mode-only"><img width="20" src="/img/white/windows.svg"></a><a href="https://surrealdb.com/install#gh-light-mode-only"><img width="20" src="/img/black/windows.svg"></a>
&nbsp;Install on Windows
</h4>
</h4> -->

### Install on Windows

The easiest and preferred way to get going with SurrealDB on Windows is to install and use the SurrealDB command-line tool. Run the following command in your terminal and follow the on-screen instructions.

```ps1
iwr https://windows.surrealdb.com -useb | iex
```

<h4><a href="https://surrealdb.com/install#gh-dark-mode-only"><img width="20" src="/img/white/docker.svg"></a><a href="https://surrealdb.com/install#gh-light-mode-only"><img width="20" src="/img/black/docker.svg"></a>
<!-- <h4><a href="https://surrealdb.com/install#gh-dark-mode-only"><img width="20" src="/img/white/docker.svg"></a><a href="https://surrealdb.com/install#gh-light-mode-only"><img width="20" src="/img/black/docker.svg"></a>
&nbsp;Run using Docker
</h4>
</h4> -->

### Run using Docker

Docker can be used to manage and run SurrealDB database instances without the need to install any command-line tools. The SurrealDB docker container contains the full command-line tools for importing and exporting data from a running server, or for running a server itself.

Expand All @@ -193,7 +191,7 @@ For just getting started with a development server running in memory, you can pa
docker run --rm --pull always --name surrealdb -p 8000:8000 surrealdb/surrealdb:latest start --log trace --user root --pass root memory
```

<h2><img height="20" src="/img/gettingstarted.svg">&nbsp;&nbsp;Getting started</h2>
<h2><img height="20" src="./img/gettingstarted.svg">&nbsp;&nbsp;Getting started</h2>

Getting started with SurrealDB is as easy as starting up the SurrealDB database server, choosing your platform, and integrating its SDK into your code. You can easily get started with your platform of choice by reading one of our tutorials.

Expand Down Expand Up @@ -222,7 +220,7 @@ Getting started with SurrealDB is as easy as starting up the SurrealDB database
- [ ] [Getting started with Swift](https://surrealdb.com/docs/integration/libraries/swift) (coming soon)
- [ ] [Getting started with R](https://surrealdb.com/docs/integration/libraries/r) (coming soon)

<h2><img height="20" src="/img/features.svg">&nbsp;&nbsp;Quick look</h2>
<h2><img height="20" src="./img/features.svg">&nbsp;&nbsp;Quick look</h2>

With strongly-typed data types, data can be fully modelled right in the database.

Expand Down Expand Up @@ -356,7 +354,7 @@ DEFINE TABLE post SCHEMALESS
;
```

<h2><img height="20" src="/img/features.svg">&nbsp;&nbsp;Why SurrealDB?</h2>
<h2><img height="20" src="./img/features.svg">&nbsp;&nbsp;Why SurrealDB?</h2>

#### Database, API, and permissions

Expand Down Expand Up @@ -418,7 +416,7 @@ Built entirely in Rust as a single library, SurrealDB is designed to be used as

![Designed to be embedded or in the cloud](/img/illustrations/cloud-or-embedded.png)

<h2><img height="20" src="/img/community.svg">&nbsp;&nbsp;Community</h2>
<h2><img height="20" src="./img/community.svg">&nbsp;&nbsp;Community</h2>

Join our growing community around the world, for help, ideas, and discussions regarding SurrealDB.

Expand All @@ -430,15 +428,15 @@ Join our growing community around the world, for help, ideas, and discussions re
- Join our [Dev community](https://dev.to/surrealdb)
- Questions tagged #surrealdb on [Stack Overflow](https://stackoverflow.com/questions/tagged/surrealdb)

<h2><img height="20" src="/img/contributing.svg">&nbsp;&nbsp;Contributing</h2>
<h2><img height="20" src="./img/contributing.svg">&nbsp;&nbsp;Contributing</h2>

We would &nbsp;<img width="15" src="/img/love.svg">&nbsp; for you to get involved with SurrealDB development! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](CONTRIBUTING.md).
We would &nbsp;<img width="15" src="./img/love.svg">&nbsp; for you to get involved with SurrealDB development! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](CONTRIBUTING.md).

<h2><img height="20" src="/img/security.svg">&nbsp;&nbsp;Security</h2>
<h2><img height="20" src="./img/security.svg">&nbsp;&nbsp;Security</h2>

For security issues, view our [vulnerability policy](https://github.com/surrealdb/surrealdb/security/policy), view our [security policy](https://surrealdb.com/legal/security), and kindly email us at [[email protected]](mailto:[email protected]) instead of posting a public issue on GitHub.

<h2><img height="20" src="/img/license.svg">&nbsp;&nbsp;License</h2>
<h2><img height="20" src="./img/license.svg">&nbsp;&nbsp;License</h2>

Source code for SurrealDB is variously licensed under a number of different licenses. A copy of each license can be found in [each repository](https://github.com/surrealdb).

Expand Down