diff --git a/README.md b/README.md index 7213277..64f5d6c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ SQLocal makes it easy to run SQLite3 in the browser, backed by the origin privat - ๐Ÿงต Runs the SQLite engine in a web worker so queries do not block the main thread - ๐Ÿ“‚ Persists data to the origin private file system, which is optimized for fast file I/O - ๐Ÿ”’ Each user can have their own private database instance -- ๐Ÿš€ Simple API; just create a database and start running SQL queries +- ๐Ÿš€ Simple API; just name your database and start running SQL queries - ๐Ÿ› ๏ธ Works with Kysely and Drizzle ORM for making type-safe queries ## Examples @@ -26,8 +26,8 @@ const { sql } = new SQLocal('database.sqlite3'); // against the SQLite database await sql`CREATE TABLE groceries (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT)`; -// Execute a prepared statement just by inserting parameters -// in the SQL string +// Execute a parameterized statement just by inserting +// parameters in the SQL string const items = ['bread', 'milk', 'rice']; for (let item of items) { await sql`INSERT INTO groceries (name) VALUES (${item})`; diff --git a/docs/.firebaserc b/docs/.firebaserc deleted file mode 100644 index c0e942d..0000000 --- a/docs/.firebaserc +++ /dev/null @@ -1,5 +0,0 @@ -{ - "projects": { - "default": "sqlocal-lib" - } -} diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index dbb58ff..0000000 --- a/docs/.gitignore +++ /dev/null @@ -1,66 +0,0 @@ -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* -firebase-debug.log* -firebase-debug.*.log* - -# Firebase cache -.firebase/ - -# Firebase config - -# Uncomment this if you'd like others to create their own Firebase project. -# For a team working on the same Firebase project(s), it is recommended to leave -# it commented so all members can deploy to the same project(s) in .firebaserc. -# .firebaserc - -# Runtime data -pids -*.pid -*.seed -*.pid.lock - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# Bower dependency directory (https://bower.io/) -bower_components - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (http://nodejs.org/api/addons.html) -build/Release - -# Dependency directories -node_modules/ - -# Optional npm cache directory -.npm - -# Optional eslint cache -.eslintcache - -# Optional REPL history -.node_repl_history - -# Output of 'npm pack' -*.tgz - -# Yarn Integrity file -.yarn-integrity - -# dotenv environment variables file -.env diff --git a/docs/firebase.json b/docs/firebase.json deleted file mode 100644 index 11d6f5d..0000000 --- a/docs/firebase.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "hosting": { - "public": ".vitepress/dist", - "cleanUrls": true, - "ignore": ["firebase.json", "**/.*", "**/node_modules/**"] - } -} diff --git a/docs/guide/introduction.md b/docs/guide/introduction.md index 5b8ae5e..5d620ae 100644 --- a/docs/guide/introduction.md +++ b/docs/guide/introduction.md @@ -19,8 +19,8 @@ const { sql } = new SQLocal('database.sqlite3'); // against the SQLite database await sql`CREATE TABLE groceries (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT)`; -// Execute a prepared statement just by inserting parameters -// in the SQL string +// Execute a parameterized statement just by inserting +// parameters in the SQL string const items = ['bread', 'milk', 'rice']; for (let item of items) { await sql`INSERT INTO groceries (name) VALUES (${item})`; diff --git a/docs/index.md b/docs/index.md index 48e0416..7a3ca57 100644 --- a/docs/index.md +++ b/docs/index.md @@ -31,7 +31,7 @@ features: details: Each user can have their own private database instance - title: Simple API icon: ๐Ÿš€ - details: Just create a database and start running SQL queries + details: Just name your database and start running SQL queries - title: TypeScript icon: ๐Ÿ› ๏ธ details: Works with Kysely and Drizzle ORM for making type-safe queries