From cdbd17f10ccf2b679a71a4643726ec5c3ba9265b Mon Sep 17 00:00:00 2001 From: Obinna Ekwuno Date: Tue, 17 Sep 2024 16:12:44 +0100 Subject: [PATCH] Update README.md --- README.md | 122 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 83 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 1db3fb399..4f43954e4 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,98 @@ -# Astro Starter Kit: Basics +
-```sh -npm create astro@latest -- --template basics -``` +

+ + SurrealDB Logo + + + SurrealDB Logo + +

-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) +

+ + SurrealDB + + + SurrealDB + + is the ultimate cloud
database for tomorrow's applications +

-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +

Develop easier.   Build faster.   Scale quicker.

-![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554) +
-## 🚀 Project Structure +

The documentation for SurrealDB, built using Docusaurus.

-Inside of your Astro project, you'll see the following folders and files: +

If you want to contribute, then please read the contributing guidelines.

-```text -/ -├── public/ -│ └── favicon.svg -├── src/ -│ ├── components/ -│ │ └── Card.astro -│ ├── layouts/ -│ │ └── Layout.astro -│ └── pages/ -│ └── index.astro -└── package.json -``` +
+ +

+ +   + +   + +   + +   + +

+ +

+ Blog +   + Github +   + LinkedIn +   + Twitter +   + Youtube +   + Dev +   + Discord +   + StackOverflow +

+ +
+ +## Getting started with SurrealDB + +Visit [surrealdb.com/docs](https://surrealdb.com/docs/surrealdb/) to get started with SurrealDB. + +## Contributing to the documentation + +Please see our [contributing guidelines](/CONTRIBUTING.md). -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. +### Good First Issues -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. +We have a list of [good first issues](https://github.com/surrealdb/docs.surrealdb.com/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process. -Any static assets, like images, can be placed in the `public/` directory. +### Installation -## 🧞 Commands +To get started with contributing to the SurrealDB documentation, first install the required packages using the following command. -All commands are run from the root of the project, from a terminal: +``` +$ pnpm install +``` + +### Development -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | +The following command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. -## 👀 Want to learn more? +``` +$ pnpm start +``` -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +### Building + +The following command builds and generates static content into the `build` directory, and can then be served using any static contents hosting service. + +``` +$ pnpm build +```