Skip to content
This repository has been archived by the owner on Jul 16, 2020. It is now read-only.

Commit

Permalink
chore(readme): Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
davideast committed Jun 6, 2016
1 parent 3f8a4c9 commit d568ac1
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,19 @@
- **No client-side filtering** - Querybase genererates composite keys to provide querying on multiple fields.
- **Simple Query API** - Use common query methods such as `.greaterThan()`, `.lessThan()`, and `.startsWith()`.

## Documentation
## Install

```bash
npm install querybase --save
```

Use via [npmcdn](https://npmcdn.com)

```html
<script src="https://npmcdn.com/querybase@0.2.0></script>
```
## Example usage
Querybase takes a Firebase Database reference with a list of fields to create composite keys.
Expand Down Expand Up @@ -42,6 +54,8 @@ const queriedDbRef = querybaseRef
```
### Querying using one field
Querybase also provides rich querying methods for single fields.
```js
const databaseRef = firebase.database.ref().child('people');
Expand Down

0 comments on commit d568ac1

Please sign in to comment.