surrealdb / surrealdb.wasm

A WebAssembly engine for the SurrealDB JavaScript SDK
https://surrealdb.com
Apache License 2.0
112 stars 17 forks source link

Documentation: add a list of API changes from 0.7 to 0.8 #55

Open krisangle opened 6 months ago

krisangle commented 6 months ago

Description

It seems there are some breaking changes between the V0.8 and V0.7 of the surrealdb.wasm lib:

More generally, it would be appreciated to list the features/changes between versions of this wasm library. It would also be nice to cite which version of the surrealdb engine the wasm library is built on, as some SQL language features might not be available. Last suggestion: the documentation is lacking the structure of the returned values when calling the API.

Finally, the examples are lacking on how to use the library either as clientside-memory or with indexdb persistence. I could pick-up some tricks from some youtube video tutorials, but a bit tough to reach.

I believe this product is great, keep going guys!

Is there an existing issue for this?

Code of Conduct

limcheekin commented 6 months ago

Thanks for created the issue.

As the creator of the surrealdb_wasm flutter package which depends on the surrealdb.wasm, I can't agreed more the changes of the API need to be well-documented.

Otherwise, it is like let the user flying in the dark.