From 3a2bd3db5729bad483532bf19c1bc0e15ffdc765 Mon Sep 17 00:00:00 2001 From: Anton Golub Date: Fri, 22 Sep 2023 11:21:31 +0300 Subject: [PATCH] docs: mention git user config opts --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a72b9e3..274a4c5 100644 --- a/README.md +++ b/README.md @@ -13,22 +13,25 @@ It does not seem possible [to get commits info w/o repo cloning](https://stackov import {createTower} from 'tagtower' const tower = createTower({ - url: 'https://github.com/git/repo.git', - branch: 'tagtower' + 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-')) + committerName: 'Foo Bar', // Username and email to sign annotaged git tags + committerEmail: 'foo@bar.baz' // Defaults to Semrel Extra Bot }) const id: string = 'some@tag' const data: Record = { - hash: '3f9f0a88b411a8932bce289a3dd498d70a4dc96c', - author: 'Anton Golub ', - message: `feat: initial feat` + hash: '3f9f0a88b411a8932bce289a3dd498d70a4dc96c', + author: 'Anton Golub ', + message: 'feat: initial feat' } -await tower.create(id, data) // stores entry to the specified remote -await tower.read(id) // returns found TEntry | null -await tower.read() // if tag is empty, returns TEntry[] -await tower.update(id, data) // just a shortcut for delete & create -await tower.delete(id) // void +await tower.create(id, data) // stores entry to the specified remote +await tower.read(id) // returns found TEntry | null +await tower.read() // if tag is empty, returns TEntry[] +await tower.update(id, data) // just a shortcut for delete & create +await tower.delete(id) // void ``` ## License