Update documents

documents/README.md

@@ -11,14 +11,14 @@ The fantastic ORM library for Golang, aims to be developer friendly.
 * Full-Featured ORM (almost)
 * Chainable API
 * Auto Migrations
-* Relations (Has One, Has Many, Belongs To, Many To Many, [Polymorphism](#polymorphism))
+* Relations (Has One, Has Many, Belongs To, Many To Many, Polymorphism)
 * Callbacks (Before/After Create/Save/Update/Delete/Find)
 * Preloading (eager loading)
 * Transactions
 * Embed Anonymous Struct
 * Soft Deletes
 * Customizable Logger
-* Iteration Support via [Rows](#row--rows)
+* Iteration Support via Rows
 * Every feature comes with tests
 * Developer Friendly
 
@@ -28,6 +28,10 @@ The fantastic ORM library for Golang, aims to be developer friendly.
 go get -u github.com/jinzhu/gorm
 ```
 
+## Upgrading
+
+[Change Log](http://jinzhu.github.io/gorm/changelog.html)
+
 ## Basic Usage
 
 ```go

documents/SUMMARY.md

@@ -29,3 +29,4 @@
   * [Overriding Logger](advanced.md#logger)
 * [Development](development.md)
   * [Write Plugins](development.md#callbacks)
+* [Change Log](changelog.md)

documents/changelog.md

@@ -0,0 +1,54 @@
+# Change Log
+
+## v1.0
+
+#### Breaking Changes
+
+* **`gorm.Open` return type `*gorm.DB` instead of `gorm.DB`**
+
+* **Updating will only update changed fields**
+
+  Most applications won't be affected, only when you are changing updating values in callbacks like `BeforeSave`, `BeforeUpdate`, you should use `scope.SetColumn` then, for example:
+
+  ```go
+  func (user *User) BeforeUpdate(scope *gorm.Scope) {
+    if pw, err := bcrypt.GenerateFromPassword(user.Password, 0); err == nil {
+      scope.SetColumn("EncryptedPassword", pw)
+      // user.EncryptedPassword = pw  // doesn't work, won't including EncryptedPassword field when updating
+    }
+  }
+  ```
+
+* **Soft delete's default querying scope will only check `deleted_at IS NULL`**
+
+  Before `db.Find(&user)` will generate querying SQL if user has `DeletedAt` field
+
+  `SELECT * FROM users WHERE deleted_at IS NULL OR deleted_at <= '0001-01-02'`
+
+  Now won't include blank time check `<= '0001-01-02` anymore, will generat SQL like:
+
+  `SELECT * FROM users WHERE deleted_at IS NULL`
+
+  So your application's `DeletedAt` field should not use `time.Time` as data type, need to use pointer `*time.Time` or something like `NullTime`.
+  If you are using `gorm.Model`, then you are good, nothing need to be change, just make sure all records using blank time for `deleted_at` has been set to NULL, sample migration script:
+
+  ```go
+  import (
+      "github.com/jinzhu/now"
+  )
+
+  func main() {
+    var models = []interface{}{&User{}, &Image{}}
+    for _, model := range models {
+      db.Unscoped().Model(model).Where("deleted_at < ?", now.MustParse("0001-01-02")).Update("deleted_at", gorm.Expr("NULL"))
+    }
+  }
+  ```
+
+* **New ToDBName logic**
+
+  Before when GORM convert Struct, Field's name to db name, only those common initialisms from [golint](https://github.com/golang/lint/blob/master/lint.go#L702) like `HTTP`, `URI` are special handled.
+
+  So field `HTTP`'s db name will be `http` not `h_t_t_p`, but some other initialisms like `SKU` that not in golint, it's db name will be `s_k_u`, this release fixed this, any upper case initialisms should be converted correctly.
+
+  If your applications using some upper case initialisms which doesn't exist in [golint](https://github.com/golang/lint/blob/master/lint.go#L702), you need to overwrite generated column name with tag, like `sql:"column:s_k_u"`, or alert your database's column name according to new logic