Skip to content

Commit 5dd6b5c

Browse files
committed
docs: add link to the docs to the readme
1 parent fd3277b commit 5dd6b5c

File tree

2 files changed

+4
-7
lines changed

2 files changed

+4
-7
lines changed

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
11
## Vue-TinyBase
22

3-
**Warning**: This is a work-in-progress. Avoid using in production.
4-
5-
Documentation is not available, check example typescript app to see how to use it for experiments.
6-
7-
To have typescript support check `packages/examples/todolist-ts/src/store.ts` file.
8-
9-
All event listeners and composables are auto-generated from tinybase `store.d.ts` file, only `valueRef` and `cellRef` are not auto-generated.
3+
Check the official documentation [here](https://vue-tinybase.com/)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Vue-TinyBase
2+
3+
Check the official documentation [here](https://vue-tinybase.com/)

0 commit comments

Comments
 (0)