From c515d4efdf70c09bc40c6829776da12fff2d89b8 Mon Sep 17 00:00:00 2001
From: Wing-Kam Wong <wingkwong.code@gmail.com>
Date: Sat, 12 Jun 2021 22:22:48 +0800
Subject: [PATCH] docs: update README.md

Signed-off-by: Wing-Kam Wong <wingkwong.code@gmail.com>
---
 packages/nc-gui/README.md     |  2 +-
 packages/nc-lib-gui/README.md | 12 +++---------
 packages/nocodb/README.md     | 21 +++++++++++++++++++++
 3 files changed, 25 insertions(+), 10 deletions(-)

diff --git a/packages/nc-gui/README.md b/packages/nc-gui/README.md
index c105db5d04..bec73bc9b3 100644
--- a/packages/nc-gui/README.md
+++ b/packages/nc-gui/README.md
@@ -1,4 +1,4 @@
-# xc-electron-web
+# nc-gui
 
 ## Build Setup
 
diff --git a/packages/nc-lib-gui/README.md b/packages/nc-lib-gui/README.md
index 7ff9e6d760..e420ed6ca4 100644
--- a/packages/nc-lib-gui/README.md
+++ b/packages/nc-lib-gui/README.md
@@ -1,11 +1,5 @@
-# `xc-tool-web`
+# nc-lib-gui
 
-> TODO: description
+This package is the build version of ``nc-gui`` which will be used in ``packages/nocodb``. The built files should be located in ``packages/nc-lib-gui/lib/dist/``. 
 
-## Usage
-
-```
-const xcToolWeb = require('xc-tool-web');
-
-// TODO: DEMONSTRATE API
-```
+To build the frontend and copy the built files to dist directory, run ``npm run build:copy`` under ``packages/nc-gui/``.
\ No newline at end of file
diff --git a/packages/nocodb/README.md b/packages/nocodb/README.md
index e69de29bb2..8f5aafdd84 100644
--- a/packages/nocodb/README.md
+++ b/packages/nocodb/README.md
@@ -0,0 +1,21 @@
+# nocodb
+
+## Running locally
+
+Even though this package is a backend project, you can still visit the dashboard as it includes ``nc-lib-gui``. 
+
+```
+npm install
+npm run watch:run
+# open localhost:8080/dashboard in browser
+```
+
+As ``nc-lib-gui`` is hosted in npm registry, for local development, you should run ``nc-gui`` separately. 
+
+If you wish to combine the frontend and backend together in your local devlopment environment, you may use ``packages/nc-lib-gui`` as a local depenedency by updating the ``packages/nocodb/package.json`` to 
+
+```json
+"nc-lib-gui": "file:../nc-lib-gui"
+```
+
+In this case, whenever there is any changes made in frontend, you need to run ``npm run build:copy`` under ``packages/nc-gui/``.
\ No newline at end of file