Skip to content

Commit

Permalink
Update some verbiage in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
BrandonRomano committed May 24, 2016
1 parent 35fa623 commit 8caa2c2
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,17 +158,18 @@ This value specifies that this field can unique identify an entry in the datasto
You do not _need_ to set this to true for all of your `UNIQUE` fields in your datastore, but you can.

Setting `UniqueIdentifier` to true gives you the following:
- The ability to set that fields value in the `serf.BaseModel` and call `Load()` against it.
- Call `Update()` with this field in the where clause / filter
- Call `Delete()` with this field in the where clause / filter.

- The ability to set that fields value in the `serf.BaseModel` and call `Load()` against it.
- Call `Update()` with this field in the where clause / filter
- Call `Delete()` with this field in the where clause / filter.

> If you are using a `serf.Worker` that is backed by a relational database, it is strongly recommended that column is indexed.
#### IsSet

This is a function that determines if the value in the struct is set or not.

This is only required if `UniqueIdentifier` is set.
This is only required if `UniqueIdentifier` is set to `true`.

This function will likely look something like this:

Expand All @@ -183,7 +184,7 @@ IsSet: func(pointer interface{}) bool {

## Workers

Workers are simply implementations that adhere to this interface:
Workers are simply implementations that adhere to the following interface:

```go
type Worker interface {
Expand Down

0 comments on commit 8caa2c2

Please sign in to comment.