Skip to content

Commit 3b27918

Browse files
authored
docs: fix typos
1 parent bea97a0 commit 3b27918

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# SQLite compiled to javascript
1+
# SQLite compiled to JavaScript
22
[![Build Status](https://travis-ci.org/kripken/sql.js.svg?branch=master)](http://travis-ci.org/kripken/sql.js) [![CDNJS version](https://img.shields.io/cdnjs/v/sql.js.svg)](https://cdnjs.com/libraries/sql.js)
33

44
For the impatients, try the demo here: http://kripken.github.io/sql.js/examples/GUI
55

6-
*sql.js* is a port of [SQLite](http://sqlite.org/about.html) to Webassembly, by compiling the SQLite C code with [Emscripten](http://kripken.github.io/emscripten-site/docs/introducing_emscripten/about_emscripten.html). It uses a [virtual database file stored in memory](https://kripken.github.io/emscripten-site/docs/porting/files/file_systems_overview.html), and thus **doesn't persist the changes** made to the database. However, it allows you to **import** any existing sqlite file, and to **export** the created database as a [javascript typed array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays).
6+
*sql.js* is a port of [SQLite](http://sqlite.org/about.html) to Webassembly, by compiling the SQLite C code with [Emscripten](http://kripken.github.io/emscripten-site/docs/introducing_emscripten/about_emscripten.html). It uses a [virtual database file stored in memory](https://kripken.github.io/emscripten-site/docs/porting/files/file_systems_overview.html), and thus **doesn't persist the changes** made to the database. However, it allows you to **import** any existing sqlite file, and to **export** the created database as a [JavaScript typed array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays).
77

8-
There are no C bindings or node-gyp compilation here, sql.js is a simple javascript file, that can be used like any traditional javascript library. If you are building a native application in javascript (using Electron for instance), or are working in node.js, you will likely prefer to use [a native binding of SQLite to javascript](https://www.npmjs.com/package/sqlite3).
8+
There are no C bindings or node-gyp compilation here, sql.js is a simple JavaScript file, that can be used like any traditional JavaScript library. If you are building a native application in JavaScript (using Electron for instance), or are working in node.js, you will likely prefer to use [a native binding of SQLite to JavaScript](https://www.npmjs.com/package/sqlite3).
99

1010
SQLite is public domain, sql.js is MIT licensed.
1111

@@ -24,9 +24,9 @@ A [full documentation](http://kripken.github.io/sql.js/documentation/#http://kri
2424
```javascript
2525
var initSqlJs = require('sql.js');
2626
// or if you are in a browser:
27-
//var initSqlJs = window.initSqlJs;
27+
// var initSqlJs = window.initSqlJs;
2828

29-
initSqlJs().then(function(SQL){
29+
initSqlJs().then(SQL => {
3030

3131
// Create a database
3232
var db = new SQL.Database();
@@ -57,7 +57,7 @@ initSqlJs().then(function(SQL){
5757
stmt.bind([0, 'hello']);
5858
while (stmt.step()) console.log(stmt.get()); // Will print [0, 'hello']
5959

60-
// You can also use javascript functions inside your SQL code
60+
// You can also use JavaScript functions inside your SQL code
6161
// Create the js function you need
6262
function add(a, b) {return a+b;}
6363
// Specifies the SQL function's name, the number of it's arguments, and the js function to use
@@ -89,7 +89,7 @@ The test files provide up to date example of the use of the api.
8989
<script src='/dist/sql-wasm.js'></script>
9090
<script>
9191
config = {
92-
locateFile: url => `/dist/${filename}`
92+
locateFile: filename => `/dist/${filename}`
9393
}
9494
// The `initSqlJs` function is globally provided by all of the main dist files if loaded in the browser.
9595
// We must specify this locateFile function if we are loading a wasm file from anywhere other than the current html page's folder.
@@ -220,7 +220,7 @@ See [examples/GUI/gui.js](examples/GUI/gui.js) for a full working example.
220220

221221
## Flavors/versions Targets/Downloads
222222

223-
This library includes both WebAssembly and asm.js versions of Sqlite. (WebAssembly is the newer, preferred way to compile to Javascript, and has superceded asm.js. It produces smaller, faster code.) Asm.js versions are included for compatibility.
223+
This library includes both WebAssembly and asm.js versions of Sqlite. (WebAssembly is the newer, preferred way to compile to JavaScript, and has superceded asm.js. It produces smaller, faster code.) Asm.js versions are included for compatibility.
224224

225225
## Upgrading from 0.x to 1.x
226226

0 commit comments

Comments
 (0)