Skip to content

Commit ef61eb0

Browse files
author
Georges
committed
Update README.md
1 parent 888255c commit ef61eb0

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
angular-sql-query
22
=====================
3-
Make simple query on a SQLite database
3+
A simpler way to query a SQLite database
44

55
[![NPM version][npm-image]][npm-url]
66
[![Build status][travis-image]][travis-url]
@@ -40,11 +40,11 @@ When you're done, your setup should look similar to the following:
4040
</html>
4141
```
4242
##Configuration
43-
For use this module, you're database need to architectured whith this field:
43+
For using this module, your database need to be architectured with these fields:
4444
- `id`: Unique key for data.
4545
- `payload`: Object data stringify with angular.toJson.
4646

47-
You can helped by [angular-sql-storage](https://github.com/SimpliField/angular-sql-storage) module.
47+
For some extra helpers regarding storage, you can look at this module [angular-sql-storage](https://github.com/SimpliField/angular-sql-storage).
4848

4949
**Example**
5050

@@ -66,7 +66,7 @@ var user = new sqlStorageService('user', $q.when(databaseInstance), {
6666

6767
##API Documentation
6868
##getBackUp
69-
Get data by his id
69+
Get data by its id
7070

7171
**Params**
7272
- `id`: Data id
@@ -78,7 +78,7 @@ user.getBackUp(1);
7878
```
7979

8080
##listBackUp
81-
All table datas
81+
All datas
8282

8383
**Returns:** [Array] `payload`
8484

@@ -87,10 +87,10 @@ user.listBackUp();
8787
```
8888

8989
##queryBackUp
90-
All datas correspond to query.<br/>
90+
All datas corresponding to query.<br/>
9191
If field is referenced in options, query can be set directly in SQl Query. Also, a javascript filter is used.<br/>
9292
You need to pass an object; the key is the field name and the value is the query value.<br/>
93-
You can pass an **Array** for make a `IN` query or a **Boolean** for a 1 or 0 query.
93+
You can pass an **Array** to make a `IN` query or a **Boolean** for a 1 or 0 query.
9494

9595
**Params:**
9696
- `params`: [Object] Filter datas
@@ -142,12 +142,12 @@ user.removeBackUp(1);
142142
```
143143

144144
##bulkDocsBackUp
145-
Modify mutliple datas<br/>
145+
Modify multiple datas<br/>
146146
It's possible to update or remove datas with one method called.<br/>
147-
You can delete a data by set a object key `_delete` to true.
147+
You can delete a data by setting an the object key `_delete` to true.
148148

149149
**Params:**
150-
- `datas`: Array of object to update.
150+
- `datas`: Array of objects to update.
151151

152152
**Returns:** `SQL update result`
153153

0 commit comments

Comments
 (0)