From 20a98e07f912b2a5a3fe31b48c3e831e75d6834e Mon Sep 17 00:00:00 2001 From: Hau Nguyen Date: Fri, 22 Jul 2022 23:11:07 +0700 Subject: [PATCH] chore: add install, guide in readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index cdc2be6..b5795cf 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,29 @@ Only upgrade specific subset not all modules. +## Install + +Should use Go version `>= 1.16`: + +```sh +go install github.com/haunt98/update-go-mod/cmd/update-go-mod@latest +``` + +## Usage + +Create local file `.deps` or use url depends on your use case: + +```sh +# Default read from .deps +update-go-mod + +# Read from URL +update-go-mod --deps-url "https://example.txt" + +# Don't do anythin +update-go-mod --dry-run +``` + ## Thanks - [Managing dependencies](https://go.dev/doc/modules/managing-dependencies)