Skip to content

Commit db9252f

Browse files
committed
Merge branch 'master' into gh-pages
2 parents 786e7ab + bea97a0 commit db9252f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ There are no C bindings or node-gyp compilation here, sql.js is a simple javascr
99

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

12-
Sql.js predates WebAssembly, and thus started as an [asm.js](https://en.wikipedia.org/wiki/Asm.js) project. It still supports asm.js for backwards compatability.
12+
Sql.js predates WebAssembly, and thus started as an [asm.js](https://en.wikipedia.org/wiki/Asm.js) project. It still supports asm.js for backwards compatibility.
1313

1414
## Version of binaries
1515
Sql.js was last built with:
@@ -22,7 +22,7 @@ A [full documentation](http://kripken.github.io/sql.js/documentation/#http://kri
2222
## Usage
2323

2424
```javascript
25-
var initSqlJs = require('sql-wasm.js');
25+
var initSqlJs = require('sql.js');
2626
// or if you are in a browser:
2727
//var initSqlJs = window.initSqlJs;
2828

@@ -114,12 +114,12 @@ The test files provide up to date example of the use of the api.
114114
});
115115
</script>
116116
<body>
117-
Output is in Javscript console
117+
Output is in Javascript console
118118
</body>
119119
</html>
120120
```
121121

122-
#### Creating a database from a file choosen by the user
122+
#### Creating a database from a file chosen by the user
123123
`SQL.Database` constructor takes an array of integer representing a database file as an optional parameter.
124124
The following code uses an HTML input as the source for loading a database:
125125
```javascript
@@ -237,7 +237,7 @@ So in the past, you would:
237237
or:
238238
```javascript
239239
var SQL = require('sql.js');
240-
var db = new QL.Database();
240+
var db = new SQL.Database();
241241
//...
242242
```
243243

@@ -263,15 +263,15 @@ initSqlJs().then(function(SQL){
263263
`NOTHING` is now a reserved word in SQLite, whereas previously it was not. This could cause errors like `Error: near "nothing": syntax error`
264264

265265
### Downloading/Using: ###
266-
Although asm.js files were distributed as a single Javascript file, WebAssembly libraries are most efficiently distributed as a pair of files, the `.js` loader and the `.wasm` file, like [dist/sql-wasm.js]([dist/sql-wasm.js]) and [dist/sql-wasm.wasm]([dist/sql-wasm.wasm]). The `.js` file is reponsible for wrapping/loading the `.wasm` file.
266+
Although asm.js files were distributed as a single Javascript file, WebAssembly libraries are most efficiently distributed as a pair of files, the `.js` loader and the `.wasm` file, like [dist/sql-wasm.js]([dist/sql-wasm.js]) and [dist/sql-wasm.wasm]([dist/sql-wasm.wasm]). The `.js` file is responsible for wrapping/loading the `.wasm` file.
267267

268268

269269

270270

271271
## Versions of sql.js included in `dist/`
272272
- `sql-wasm.js` : The Web Assembly version of Sql.js. Minified and suitable for production. Use this. If you use this, you will need to include/ship `sql-wasm.wasm` as well.
273273
- `sql-wasm-debug.js` : The Web Assembly, Debug version of Sql.js. Larger, with assertions turned on. Useful for local development. You will need to include/ship `sql-wasm-debug.wasm` if you use this.
274-
- `sql-asm.js` : The older asm.js version of Sql.js. Slower and larger. Provided for compatiblity reasons.
274+
- `sql-asm.js` : The older asm.js version of Sql.js. Slower and larger. Provided for compatibility reasons.
275275
- `sql-asm-memory-growth.js` : Asm.js doesn't allow for memory to grow by default, because it is slower and de-optimizes. If you are using sql-asm.js and you see this error (`Cannot enlarge memory arrays`), use this file.
276276
- `sql-asm-debug.js` : The _Debug_ asm.js version of Sql.js. Use this for local development.
277277
- `worker.*` - Web Worker versions of the above libraries. More limited API. See [examples/GUI/gui.js](examples/GUI/gui.js) for a good example of this.

0 commit comments

Comments
 (0)