From 66eb30f67d3b84256b628e8f6a075d4b002800e1 Mon Sep 17 00:00:00 2001 From: Do Nhu Vy Date: Thu, 2 Mar 2023 15:16:44 +0700 Subject: [PATCH] Revise README for correction. --- README.md | 41 +++++++++++++++++++---------------------- 1 file changed, 19 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 0c9ab74e..399e8bda 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,43 @@ # GORM -The fantastic ORM library for Golang, aims to be developer friendly. +Easy-to-use ORM lib for Golang. [![go report card](https://goreportcard.com/badge/github.com/go-gorm/gorm "go report card")](https://goreportcard.com/report/github.com/go-gorm/gorm) [![test status](https://github.com/go-gorm/gorm/workflows/tests/badge.svg?branch=master "test status")](https://github.com/go-gorm/gorm/actions) [![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT) [![Go.Dev reference](https://img.shields.io/badge/go.dev-reference-blue?logo=go&logoColor=white)](https://pkg.go.dev/gorm.io/gorm?tab=doc) -## Overview +## Highlights -* Full-Featured ORM -* Associations (Has One, Has Many, Belongs To, Many To Many, Polymorphism, Single-table inheritance) -* Hooks (Before/After Create/Save/Update/Delete/Find) -* Eager loading with `Preload`, `Joins` -* Transactions, Nested Transactions, Save Point, RollbackTo to Saved Point -* Context, Prepared Statement Mode, DryRun Mode -* Batch Insert, FindInBatches, Find To Map -* SQL Builder, Upsert, Locking, Optimizer/Index/Comment Hints, NamedArg, Search/Update/Create with SQL Expr -* Composite Primary Key -* Auto Migrations +* Full-featured ORM +* Relationship types (Has one, Has many, Belong to, many to many, polymorphism, single-table inheritance) +* Hooks (Before/After, Create/Save/Update/Delete/Find) +* Eager loading by `Preload`, `Joins` +* Transaction, nested transactions, savepoint, RollbackTo +* Context, prepared statement mode, DryRun mode +* Batch insert, FindInBatches, Find to map +* SQL builder, upsert, locking, optimizer/index/comment hints, NamedArg, Search/Update/Create with SQL expr +* Composite primary key +* Migration * Logger -* Extendable, flexible plugin API: Database Resolver (Multiple Databases, Read/Write Splitting) / Prometheus… -* Every feature comes with tests -* Developer Friendly +* Extendable, flexible plugin API: Database resolver (Multiple databases, read/write splitting) / Prometheus… -## Getting Started -* GORM Guides [https://gorm.io](https://gorm.io) -* Gen Guides [https://gorm.io/gen/index.html](https://gorm.io/gen/index.html) +## Getting started -## Contributing +* GORM guide [https://gorm.io](https://gorm.io) +* Gen guide [https://gorm.io/gen/index.html](https://gorm.io/gen/index.html) + +## Contribute [You can help to deliver a better GORM, check out things you can do](https://gorm.io/contribute.html) -## Contributors - Thank you for contributing to the GORM framework! [![Contributors](https://contrib.rocks/image?repo=go-gorm/gorm)](https://github.com/go-gorm/gorm/graphs/contributors) ## License -© Jinzhu, 2013~time.Now +© Jinzhu and GORM's committer, 2013 - 2023 Released under the [MIT License](https://github.com/go-gorm/gorm/blob/master/License)