Update readme #27

gionatamettifogo · gionatamettifogo · commit c44b01b645c7 · 2023-11-15T16:30:34.000+01:00
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 [![codecov](https://codecov.io/gh/sqlitecloud/sqlitecloud-js/graph/badge.svg?token=ZOKE9WFH62)](https://codecov.io/gh/sqlitecloud/sqlitecloud-js)
 
 > This is the future home of SQLiteCloud drivers for Javascript and Typescript v2  
-> Currently under development, please keep using https://github.com/sqlitecloud/sdk
+> Currently under development, please open an issue for any problems, suggestions.
 
 ## Install
 
@@ -18,14 +18,21 @@ npm install sqlitecloud-js
 ## Usage
 
 ```ts
-import { myPackage } from 'my-package-name'
+// import sqlitecloud driver
+import { Database } from 'sqlitecloud-js'
 
-myPackage('hello')
-//=> 'hello from my package'
+// trivial example here but let's suppose we have this in a variable
+let name = 'Ava Jones'
+
+// run our prepared statement (or plain sql) with familiar print syntax
+let results = await database.sql`SELECT * FROM people WHERE name = ${name}`
+// => returns [{ id: 5, name: 'Ava Jones', age: 22, hobby: 'Time traveling' }]
 ```
 
 ## API
 
+We are striving to be 100% compatibile with the widely used sqlite3 APIs, the difference being that this driver connects to your SQLiteCloud database. You can take you local SQLite, deploy in the cloud and keep using the same code. Easy! You can also use Database.sql to run an async query.
+
 ### myPackage(input, options?)
 
 #### input
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sqlitecloud-js",
-  "version": "0.0.16-development",
+  "version": "0.0.17-development",
   "description": "SQLiteCloud drivers for Typescript/Javascript in edge, web and node clients",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "sqlitecloud-js",`
`3`		`- "version": "0.0.16-development",`
	`3`	`+ "version": "0.0.17-development",`
`4`	`4`	`"description": "SQLiteCloud drivers for Typescript/Javascript in edge, web and node clients",`
`5`	`5`	`"main": "./lib/index.js",`
`6`	`6`	`"types": "./lib/index.d.ts",`