Skip to content

Commit a606995

Browse files
committed
Change icon, improve readme
1 parent 812097a commit a606995

File tree

3 files changed

+30
-57
lines changed

3 files changed

+30
-57
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
1-
# NocoDB
2-
This is a readme for your new Budibase plugin.
1+
# Budibase datasource plugin - NocoDB table
2+
This is a Budibase plugin to use NocoDB table as Budibase datasource.
33

4-
# Description
5-
Minimized no-code database
4+
# Introduction
65

7-
Find out more about [Budibase](https://github.com/Budibase/budibase).
6+
[Budibase](https://github.com/Budibase/budibase) is an open-source workflow platform that saves engineers time and energy building apps that integrate with any data source and speed-up any process.
87

9-
## Instructions
8+
[NocoDB](https://nocodb.com) is an a no code database platform that allows business users to create applications without code and in the form spreadsheet.
109

11-
To build your new plugin run the following in your Budibase CLI:
12-
```
13-
budi plugins --build
14-
```
10+
This is Budibase datasource plugin to use NocoDB table as Budibase datasource.
1511

16-
You can also re-build everytime you make a change to your plugin with the command:
17-
```
18-
budi plugins --watch
19-
```
12+
# Setting NocoDB Data Source
13+
14+
There are some parameters required to add NocoDB table as data source:
15+
16+
![NocoDB Datasource](readme/nocodb-datasource.png)
17+
18+
* `IsNocoDbCloud`: Set to true if the NocoDB instance is on `https://app.nocodb.com`, otherwise false.
19+
* `Host`: Url to your NocoDB instance. If it's set to empty, it'll be set to cloud NocoDB at `https://app.nocodb.com`
20+
* `ApiToken`: Api token of your account in NocoDB. See [here](https://nocodb.com/docs/product-docs/account-settings/api-tokens) on how to obtain your NocoDB ApiToken.
21+
* `BaseId`: Your NocoDB base id where the table will be used in query. The base id format should be similar with `piols8u9c10b210`.
22+
* `TableId`: Your NocoDB table id to be used in query. The table id format should be similar with `mwi4dei58h1ezte`.

0 commit comments

Comments
 (0)