Skip to content

Commit 2d265c8

Browse files
authored
docs: changed root readme (#24)
1 parent 1f47bc7 commit 2d265c8

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

README.md

+33-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,35 @@
11
# Buildstamp monorepo
2+
Utility for generating buildstamp file, which contains build meta info like gitcommit hash, timestamp, repo name and so on. This file could be a part of some release artifact (npm-package, docker-image) and makes it self-descriptive.
3+
```json
4+
{
5+
"git": {
6+
"commitId": "fc6e78b11ef4c7db1c8b89fa6b0d9b3ad4ad481d",
7+
"repoName": "qiwi/buildstamp.git",
8+
"repoUrl": "https://github.com/qiwi/buildstamp.git"
9+
},
10+
"docker": {
11+
"imageTag": "foo"
12+
},
13+
"date": "2020-08-27T20:47:41.958Z"
14+
}
15+
```
216
## Packages
3-
### core
4-
Package with buildstamp utility and API
5-
### binaries
6-
Buildstamp utility executables for different platforms
17+
### [buildstamp](https://github.com/qiwi/buildstamp/tree/master/packages/core)
18+
Buildstamp generator utility supporting native JS and CLI API
19+
```javascript
20+
import { execute } from 'buildstamp'
21+
22+
const stamp = execute({
23+
git: true,
24+
date: { format: 'iso' },
25+
docker: { imageTag: 'foo' }
26+
})
27+
```
28+
```shell script
29+
buildstamp --out.path=some/path/b.json --git --docker.imageTag=foo --date.format=iso
30+
```
31+
### [buildstamp-bin](https://github.com/qiwi/buildstamp/tree/master/packages/bin)
32+
Buildstamp generator executables for MacOS, Windows and Linux. They don't need Node.js for executing.
33+
```shell script
34+
./buildstamp-macos --out.path=some/path/b.json --git --docker.imageTag=foo --date.format=iso
35+
```

0 commit comments

Comments
 (0)