Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sandros94 committed May 29, 2024
1 parent 42b6bbe commit 7285c13
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

A Nuxt module aimed to simplify the use of SurrealDB.
A Nuxt module aimed to simplify the use of [SurrealDB](https://surrealdb.com).

- [ Release Notes](/CHANGELOG.md)
<!-- - [🏀 Online playground](https://stackblitz.com/github/sandros94/nuxt-surrealdb?file=playground%2Fapp.vue) -->
<!-- - [📖 &nbsp;Documentation](https://example.com) -->

## WIP

This is still under development and not suitable for production use. Expect breaking changes.
There are no docs atm, refer to the [playground](/playground/app.vue) or the [source code](/src/).
This module is still under development and not suitable for production use, proceed at your own risk. Expect breaking changes!
There are no docs atm, so please refer to the [playground](/playground/app.vue) or the [source code](/src/).

## Features

Expand All @@ -24,10 +24,10 @@ There are no docs atm, refer to the [playground](/playground/app.vue) or the [so
## Roadmap

- [x] custom fetch plugin and composable.
- [ ] on PAR with official [SurrealDB Rest integration](https://surrealdb.com/docs/surrealdb/integration/http).
- [ ] on PAR with the official [SurrealDB Rest integration](https://surrealdb.com/docs/surrealdb/integration/http).
- [ ] auth support.
- [ ] custom websocket composable.
- [ ] on PAR with official [SurrealDB RPC integration](https://surrealdb.com/docs/surrealdb/integration/rpc) via Websockets.
- [ ] on PAR with the official [SurrealDB RPC integration](https://surrealdb.com/docs/surrealdb/integration/rpc) via Websockets.

## Quick Setup

Expand Down

0 comments on commit 7285c13

Please sign in to comment.