Skip to content

Commit 75cdcee

Browse files
authored
Merge pull request #9 from outofgamut/add-graphic-to-readme
Add graphic to readme
2 parents b4abc50 + 9f23e22 commit 75cdcee

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
[![jSQL Logo](http://i.imgur.com/VQlJKOc.png)](http://pamblam.github.io/jSQL/)
22

3-
jSQL (Official) - Version 2.9 - *Now gluten free!*
3+
jSQL (Official) - Version 2.9 - *Now gluten free!*
44
[![npm version](https://badge.fury.io/js/jsql-official.svg)](https://badge.fury.io/js/jsql-official) [![Build Status](https://travis-ci.org/Pamblam/jSQL.svg?branch=master)](https://travis-ci.org/Pamblam/jSQL) [![Inline docs](http://inch-ci.org/github/Pamblam/jSQL.svg?branch=master)](http://inch-ci.org/github/Pamblam/jSQL)
55

66
<hr>
77

88
jSQL is a state and data management tool as well as a robust SQL engine for both Node and the browser. For complete documentation, please see [the jSQL Wiki](https://github.com/Pamblam/jSQL/wiki). For plugins, live demos and other information see the [official website](http://pamblam.github.io/jSQL/).
99

10-
Under the hood, jSQL has 3 layers:
10+
![jSQL Layers](https://i.imgur.com/WKEmFdB.jpg)
11+
12+
# Under the hood, jSQL has 3 layers...
1113

1214
- **At the Lowest level**, jSQL automatically chooses the best method of storage to save state and interacts directly with it. This layer exposes a persistence method, [`jSQL.commit()`](https://github.com/Pamblam/jSQL/wiki/Persistence-Management#jsqlcommit), which is called to serialize and store all data currently in the jSQL database on the user's hard drive. While the app is open and loaded in the browser, this data is serialized and stored within reach in the [`jSQL.tables`](https://github.com/Pamblam/jSQL/wiki/Persistence-Management#jsqltables) object where the library is able to perform operations on it.
1315

@@ -32,7 +34,7 @@ If you're running jSQL in a browser, include it in a script tag.
3234
Or use the latest version from a CDN:
3335

3436
https://gitcdn.xyz/repo/Pamblam/jSQL/master/jSQL.min.js
35-
37+
3638
If you're running jSQL in Node, `require` the jSQL module.
3739

3840
var jSQL = require("jSQL.js");
@@ -45,17 +47,17 @@ When the database has loaded into memory, you'll want to make sure you have a ta
4547
var sql = "create table if not exists users (name varchar(25), age int)";
4648
jSQL.query(sql).execute();
4749
});
48-
50+
4951
#### Insert into table
5052

5153
At some point, you might want to put some data in that table.
5254

5355
jSQL.query("insert into users ('bob', 34)").execute();
54-
56+
5557
Prefer prepared statements? Just replace values with question marks and pass the values to the execute method in an array.
56-
58+
5759
jSQL.query("insert into users (?, ?)").execute(['bob', 34]);
58-
60+
5961
#### Select from table
6062

6163
Once you've got the data in there, you're probably going to want to get it back out.
@@ -64,7 +66,7 @@ Once you've got the data in there, you're probably going to want to get it back
6466

6567
#### Persisting changes in the browser
6668

67-
When you've made changes or additions to the database, call [`jSQL.commit()`](https://github.com/Pamblam/jSQL/wiki/Persistence-Management#jsqlcommit) to commit your changes.
69+
When you've made changes or additions to the database, call [`jSQL.commit()`](https://github.com/Pamblam/jSQL/wiki/Persistence-Management#jsqlcommit) to commit your changes.
6870

6971
For more information and to read about other update, delete and other operations, see the [jSQL Wiki](https://github.com/Pamblam/jSQL/wiki#jsql-docs).
7072

@@ -91,4 +93,3 @@ Works in all major browsers, even really old ones.
9193
License info is available [here](https://github.com/Pamblam/jSQL/wiki/License).
9294

9395
<hr>
94-

0 commit comments

Comments
 (0)