diff --git a/README.md b/README.md index 57da4f5..9f1564b 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![Coverage Status](https://img.shields.io/coveralls/github/golang-migrate/migrate/master.svg)](https://coveralls.io/github/golang-migrate/migrate?branch=master) [![packagecloud.io](https://img.shields.io/badge/deb-packagecloud.io-844fec.svg)](https://packagecloud.io/golang-migrate/migrate?filter=debs) [![Docker Pulls](https://img.shields.io/docker/pulls/migrate/migrate.svg)](https://hub.docker.com/r/migrate/migrate/) +![Supported Go Versions](https://img.shields.io/badge/Go-1.9%2C%201.10-lightgrey.svg) [![GitHub Release](https://img.shields.io/github/release/golang-migrate/migrate.svg)](https://github.com/golang-migrate/migrate/releases) @@ -75,9 +76,7 @@ $ docker run -v {{ migration dir }}:/migrations --network host migrate/migrate ## Use in your Go project * API is stable and frozen for this release (v3.x). - * Package migrate has no external dependencies. - * Only import the drivers you need. - (check [dependency_tree.txt](https://github.com/golang-migrate/migrate/releases) for each driver) + * Uses [dep](https://github.com/golang/dep) to manage dependencies * To help prevent database corruptions, it supports graceful stops via `GracefulStop chan bool`. * Bring your own logger. * Uses `io.Reader` streams internally for low memory overhead. diff --git a/cli/README.md b/cli/README.md index dcbaa12..b10b8c8 100644 --- a/cli/README.md +++ b/cli/README.md @@ -9,11 +9,14 @@ $ go get -u -d github.com/golang-migrate/migrate/cli github.com/lib/pq $ go build -tags 'postgres' -o /usr/local/bin/migrate github.com/golang-migrate/migrate/cli ``` -Note: This example builds the cli which will only work with postgres. In order +##### Notes: +1. This example builds the cli which will only work with postgres. In order to build the cli for use with other databases, replace the `postgres` build tag with the appropriate database tag(s) for the databases desired. The tags correspond to the names of the sub-packages underneath the [`database`](../database) package. +1. Support for build constraints will be removed in the future: https://github.com/golang-migrate/migrate/issues/60 +1. If possible, use a dependency manager like [dep](https://github.com/golang/dep) instead of `go get` #### MacOS