Skip to content

Commit e6982de

Browse files
gionatamettifogogionatamettifogo
committed
Docs edits #29 
1 parent 802b4cb commit e6982de

20 files changed

Lines changed: 195 additions & 208 deletions

‎docs/classes/Database.html‎

Lines changed: 20 additions & 20 deletions
Large diffs are not rendered by default.

‎docs/classes/SQLiteCloudConnection.html‎

Lines changed: 12 additions & 12 deletions
Large diffs are not rendered by default.

‎docs/classes/SQLiteCloudError.html‎

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

‎docs/classes/SQLiteCloudRow.html‎

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

‎docs/classes/SQLiteCloudRowset.html‎

Lines changed: 10 additions & 10 deletions
Large diffs are not rendered by default.

‎docs/classes/Statement.html‎

Lines changed: 10 additions & 10 deletions
Large diffs are not rendered by default.

‎docs/index.html‎

Lines changed: 7 additions & 10 deletions
Large diffs are not rendered by default.

‎docs/interfaces/SQLCloudRowsetMetadata.html‎

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

‎docs/interfaces/SQLiteCloudConfig.html‎

Lines changed: 20 additions & 20 deletions
Large diffs are not rendered by default.

‎docs/markdown/README.md‎

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ sqlitecloud-js / [Exports](modules.md)
88
[![Issues][issues-img]][issues-url]
99
[![codecov](https://codecov.io/gh/sqlitecloud/sqlitecloud-js/graph/badge.svg?token=ZOKE9WFH62)](https://codecov.io/gh/sqlitecloud/sqlitecloud-js)
1010

11-
> This is the future home of SQLiteCloud drivers for Javascript and Typescript v2
12-
> Currently under development, please open an issue for any problems, suggestions.
11+
> This is the future home of [SQLiteCloud](https://sqlitecloud.io) drivers for Javascript and Typescript v2
12+
> Currently under development, please [open an issue](https://github.com/sqlitecloud/sqlitecloud-js/issues) for any problems, suggestions.
1313
1414
## Install
1515

@@ -30,32 +30,22 @@ let results = await database.sql`SELECT * FROM tracks WHERE name = ${name}`
3030
// => returns [{ AlbumId: 1, Name: 'Breaking The Rules', Composer: 'Angus Young... }]
3131
```
3232

33-
Use `Database.sql` for executing both your prepared statements and plain SQL queries asynchronously. This method returns an array of rows for SELECT queries and supports the standard syntax for UPDATE, INSERT, and DELETE.
33+
Use [Database.sql](https://sqlitecloud.github.io/sqlitecloud-js/classes/Database.html#sql) to execute prepared statements or plain SQL queries asynchronously. This method returns an array of rows for SELECT queries and supports the standard syntax for UPDATE, INSERT, and DELETE.
3434

35-
We aim for full compatibility with the established [sqlite3](https://www.npmjs.com/package/sqlite3) API, with the primary distinction being that our driver connects to SQLiteCloud databases. This allows you to migrate your local SQLite databases to the cloud while continuing to use your existing codebase.
35+
We aim for full compatibility with the established [sqlite3 API](https://www.npmjs.com/package/sqlite3), with the primary distinction being that our driver connects to SQLiteCloud databases. This allows you to migrate your [SQLite to the cloud](https://sqlitecloud.io) while continuing to use your existing codebase.
3636

3737
The package is developed entirely in TypeScript and is fully compatible with JavaScript. It doesn't require any native libraries. This makes it a straightforward and effective tool for managing cloud-based databases in a familiar SQLite environment.
3838

39-
## API
39+
## More
4040

41-
### myPackage(input, options?)
41+
How do I deploy SQLite in the cloud?
42+
[https://sqlitecloud.io](https://sqlitecloud.io)
4243

43-
#### input
44+
How do I connect SQLite cloud with Javascript?
45+
[https://sqlitecloud.github.io/sqlitecloud-js/](https://sqlitecloud.github.io/sqlitecloud-js/)
4446

45-
Type: `string`
46-
47-
Lorem ipsum.
48-
49-
#### options
50-
51-
Type: `object`
52-
53-
##### postfix
54-
55-
Type: `string`
56-
Default: `rainbows`
57-
58-
Lorem ipsum.
47+
How can I contribute or suggest features?
48+
[https://github.com/sqlitecloud/sqlitecloud-js/issues](https://github.com/sqlitecloud/sqlitecloud-js/issues)
5949

6050
[build-img]: https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml/badge.svg
6151
[build-url]: https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml

0 commit comments

Comments
 (0)