Skip to content
This repository was archived by the owner on Apr 12, 2020. It is now read-only.

Commit a70ed1d

Browse files
committed
Update README.markdown
1 parent df6a5ea commit a70ed1d

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.markdown

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Squiggle - an SQL query builder for golang
22

3-
## Goals
3+
Have a program where it's awkward or impossible to compose an SQL query in sinlge place? Tired of concatenating pieces of SQL manually? Then Squiggle is for you! Squiggle is not an ORM but a powerful light weight tool to build SQL queries piece by piece. Squiggle draws inspiration from amazing projects like [Squel.js](http://hiddentao.github.io/squel/) and [Sequel](http://sequel.rubyforge.org).
44

5-
- Ease of use
6-
- Cover 80-90% of common use cases for SQL query building
5+
## Project Goals
6+
7+
- Intuitive easy to use/read/remember DSL for query creation
8+
- Cover 100% of common use cases for SQL query building
79

810
## Example Use
911

@@ -24,13 +26,13 @@ func main() {
2426

2527
## API
2628

27-
### `Select()` - creates a new query of type SELECT
29+
#### `Select()` - creates a new query of type SELECT
2830

2931
```go
3032
squiggle.Select()
3133
```
3234

33-
### `AddFrom(string/squiggle.From...)` - appends to the FROM clause of the query
35+
#### `AddFrom(string/squiggle.From...)` - appends to the FROM clause of the query
3436

3537
```go
3638
squiggle.Select().
@@ -40,7 +42,7 @@ squiggle.Select().
4042
// => "SELECT * FROM users, db1.table1 t1, foo"
4143
```
4244

43-
### `AddField(string/squiggle.Field...)` - appends to the field/expression portion of the query
45+
#### `AddField(string/squiggle.Field...)` - appends to the field/expression portion of the query
4446

4547
```go
4648
squiggle.Select().

0 commit comments

Comments
 (0)