Skip to content

Commit 0f982e4

Browse files
committed
documentation update and housekeeping
1 parent 1fa2ec9 commit 0f982e4

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.idea
2+
dist/
23
*.db
34

45
# Binaries for programs and plugins

README.md

+23-3
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,23 @@ curl -w "\n" -d "{\"generic\": \"$RANDOM\"}" -X POST http://localhost:8080/rx/me
5353
#### Add 1000 messages to the queue.
5454
```bash
5555
time for i in {1..1000}; do curl -w "\n" -d "{\"generic\": \"$RANDOM\"}" -X POST http://localhost:8080/rx/me/generic_data/generic/test/data; done
56-
```
56+
```
57+
58+
### Building and Releasing
59+
60+
**rxtx** uses [GORELEASER] to build binaries and [Docker] containers.
61+
62+
#### Test Release Steps
63+
64+
Install [GORELEASER] with [brew] (MacOS):
65+
```bash
66+
brew install goreleaser/tap/goreleaser
67+
```
68+
69+
Build without releasing:
70+
```bash
71+
goreleaser --skip-publish --rm-dist --skip-validate
72+
```
5773

5874
#### Release Steps
5975

@@ -72,10 +88,14 @@ curl -w "\n" -d "{\"generic\": \"$RANDOM\"}" -X POST http://localhost:8080/rx/me
7288
## License
7389
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcjimti%2Frxtx.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcjimti%2Frxtx?ref=badge_large)
7490

75-
76-
7791
[homebrew]: https://brew.sh/
7892
[brew]: https://brew.sh/
7993
[GORELEASER]: https://goreleaser.com/
8094
[Docker]: https://www.docker.com/
8195
[Tag]: https://git-scm.com/book/en/v2/Git-Basics-Tagging
96+
97+
98+
[rsync]: https://en.wikipedia.org/wiki/Rsync
99+
[Docker]: https://www.docker.com/
100+
[GORELEASER]: https://goreleaser.com/
101+
[brew]: https://brew.sh/

0 commit comments

Comments
 (0)