Skip to content
This repository was archived by the owner on Oct 4, 2022. It is now read-only.

Commit 6309df9

Browse files
committed
Update README.md
1 parent eddf80a commit 6309df9

File tree

2 files changed

+13
-30
lines changed

2 files changed

+13
-30
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ tests/
44
*.csv
55

66
docker/demo/demo.linux
7+
.DS_Store

README.md

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,5 @@
11
# Clusterfunk
22

3-
## Building
4-
5-
This library requires a fairly recent version of Go, at least 1.12. If you are modifying the protobuffer files you'll need the protoc compiler. The generated files are included in the source tree so you won't need it unless you use `make generate` (or `go generate ./...`).
6-
7-
Run `make` to build the demo service. The build uses a host of checkers (golint, go vet, staticcheck, revive and golangci-lint) so you might get some errors if you miss one or more of those.
8-
9-
Get them the usual way:
10-
11-
```text
12-
go get -u golang.org/x/lint/golint
13-
go get honnef.co/go/tools/cmd/staticcheck
14-
go get -u github.com/mgechev/revive
15-
# This only works for macOS, check out https://github.com/golangci/golangci-lint#install for other platforms
16-
# go get works as well but the author doesn't recommend it.
17-
brew install golangci/tap/golangci-lint
18-
```
19-
203
## What it is
214

225
This is a cluster library for Go. At its core it uses Raft and Serf to manage
@@ -30,20 +13,19 @@ A silver bullet.
3013

3114
clusterfunk requires Go version 1.12 or later.
3215

33-
## Setting up a cluster
34-
35-
## Managing the cluster
36-
37-
## Sharding
38-
39-
### Shard functions
16+
## Building
4017

41-
### Shard weights
18+
This library requires a fairly recent version of Go, at least 1.12. If you are modifying the protobuffer files you'll need the protoc compiler. The generated files are included in the source tree so you won't need it unless you use `make generate` (or `go generate ./...`).
4219

43-
## Limitations
20+
Run `make` to build the demo service. The build uses a host of checkers (golint, go vet, staticcheck, revive and golangci-lint) so you might get some errors if you miss one or more of those.
4421

45-
## Replicated log
22+
Get them the usual way:
4623

47-
The replicated log is kept quite simple. The first byte indicates the message type
48-
and any log message type with an higher index overwrites the previous message in
49-
the log.
24+
```text
25+
go get -u golang.org/x/lint/golint
26+
go get honnef.co/go/tools/cmd/staticcheck
27+
go get -u github.com/mgechev/revive
28+
# This only works for macOS, check out https://github.com/golangci/golangci-lint#install for other platforms
29+
# go get works as well but the author doesn't recommend it.
30+
brew install golangci/tap/golangci-lint
31+
```

0 commit comments

Comments
 (0)