Skip to content

Commit

Permalink
Update readme from Quick to qb
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Peterson authored and Eric Peterson committed Dec 2, 2016
1 parent 29b34af commit e585a88
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Quick
# qb

[![Build Status](https://travis-ci.org/elpete/quick.svg?branch=master)](https://travis-ci.org/elpete/quick)
[![Build Status](https://travis-ci.org/elpete/qb.svg?branch=master)](https://travis-ci.org/elpete/quick)

## Introduction

Quick is a fluent query builder for ColdBox. Using Quick, you can:
qb is a fluent query builder for ColdBox. It is **heavily** inspired by [Eloquent](https://laravel.com/docs/5.3/eloquent) from [Laravel](https://laravel.com/) Using qb, you can:

+ Quickly scaffold simple queries
+ Make complex, out-of-order queries possible
Expand All @@ -18,8 +18,8 @@ Compare these two examples:
// Plain old CFML
q = queryExecute("SELECT * FROM users");
// Quick
query = wirebox.getInstance('Builder@Quick');
// qb
query = wirebox.getInstance('Builder@qb');
q = query.from('users').get();
```

Expand All @@ -32,8 +32,8 @@ q = queryExecute(
[ { value = '5,10,27', cfsqltype = 'CF_SQL_NUMERIC', list = true } ]
);
// Quick
query = wirebox.getInstance('Builder@Quick');
// qb
query = wirebox.getInstance('Builder@qb');
q = query.from('posts')
.whereNotNull('published_at')
.whereIn('author_id', [5, 10, 27])
Expand All @@ -43,7 +43,7 @@ q = query.from('posts')
With Quick you can easily handle setting order by statements before the columns you want or join statements after a where clause:

```cfc
query = wirebox.getInstance('Builder@Quick');
query = wirebox.getInstance('Builder@qb');
q = query.from('posts')
.orderBy('published_at')
.select('post_id', 'author_id', 'title', 'body')
Expand All @@ -59,7 +59,7 @@ q = queryExecute(
);
```

Quick enables you to explore new ways of organizing your code by letting you pass around a query builder object that will compile down to the right SQL without you having to keep track of the order, whitespace, or other SQL gotchas!
qb enables you to explore new ways of organizing your code by letting you pass around a query builder object that will compile down to the right SQL without you having to keep track of the order, whitespace, or other SQL gotchas!

Here's a gist with an example of the powerful models you can create with this!
https://gist.github.com/elpete/80d641b98025f16059f6476561d88202
Expand All @@ -71,11 +71,11 @@ https://gist.github.com/elpete/80d641b98025f16059f6476561d88202

## Installation

Installation is easy through [CommandBox](https://www.ortussolutions.com/products/commandbox) and [ForgeBox](https://www.coldbox.org/forgebox). Simply type `box install quick` to get started.
Installation is easy through [CommandBox](https://www.ortussolutions.com/products/commandbox) and [ForgeBox](https://www.coldbox.org/forgebox). Simply type `box install qb` to get started.

## Usage

To start a new query, instantiate a new Builder: `wirebox.getInstance('Builder@Quick')`.
To start a new query, instantiate a new Builder: `wirebox.getInstance('Builder@qb')`.

## Docs

Expand Down

0 comments on commit e585a88

Please sign in to comment.