diff --git a/README.md b/README.md index 2b7eaafe..35b74faa 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,20 @@ Try [LibSQL Studio](https://libsqlstudio.com/) online here. - Edit your table data in spreadsheet-like editor - Query editor with basic syntax highlighting and basic auto complete - Basic connection management + +## How to contribute + +To run the project + +``` +pnpm install +cd studio +pnpm run dev +``` + +**Folder structure** + +| Folder | Description | +| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `/gui` | This is standalone database GUI React component. It is not tied to any specific database driver, allowing users to extend and integrate it into their own projects with ease. | +| `/studio` | It is complete database GUI client as seen in https://libsqlstudio.com. Come with database drivers and many other features |