diff --git a/README.md b/README.md index 274a4c5..2d60130 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ import {createTower} from 'tagtower' const tower = createTower({ url: 'https://github.com/git/repo.git', - branch: 'tagtower', - temp: './temp', // A dir to hold temporary git channels. Defaults to fs.mkdtemp(path.join(os.tmpdir(), 'tempy-tagtower-')) + branch: 'tagtower', // Branch for storing tags. Defaults to 'tagtower' + temp: './temp', // Dir to hold temporary git channels. Defaults to fs.mkdtemp(path.join(os.tmpdir(), 'tempy-tagtower-')) committerName: 'Foo Bar', // Username and email to sign annotaged git tags committerEmail: 'foo@bar.baz' // Defaults to Semrel Extra Bot })