Moduletrace/datasquirel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Tben 2023-05-03 07:36:17 +01:00
parent ff35b8772e
commit fcb4a98b32
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -24,4 +24,13 @@ const datasquirel = require("datasquirel");
This method requires a readonly key or fullaccess key gotten from [datasquirel](https://datasquirel.com/). It uses a basic https get request paired with some query params. This method requires a readonly key or fullaccess key gotten from [datasquirel](https://datasquirel.com/). It uses a basic https get request paired with some query params.
`code` ```js
const datasquirel = require("datasquirel");
const getData = await datasquirel.get({
key: "aldhkf89asdflksdafh908asdfjkhasdf", // API Key
db: "my_database", // Database name slug (Eg. Db Name => My Database, Db Slug => my_database)
query: "SELECT * FROM blog_posts", // SQL Query
});
```
Datasquirel uses all conventional SQL query commands. However you can only use the `SELECT` command when using a readonly API key.