Skip to content

Commit 3f61172

Browse files
authored
Improve README.md (#9)
1 parent b3860f5 commit 3f61172

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,37 @@ A generic unbalanced tree implementation, where you can define which node will b
1616
go get -u github.com/johnfercher/tree
1717
```
1818

19+
## Contributing
20+
21+
| Command | Description | Dependencies |
22+
|-----------------|---------------------------------------------------|---------------------------------------------------------------|
23+
| `make build` | Build project | `go` |
24+
| `make test` | Run unit tests | `go` |
25+
| `make fmt` | Format files | `gofmt`, `gofumpt` and `goimports` |
26+
| `make lint` | Check files | `golangci-lint` and `goreportcard-cli` |
27+
| `make dod` | (Definition of Done) Format files and check files | Same as `make build`, `make test`, `make fmt` and `make lint` |
28+
| `make install` | Install all dependencies | `go`, `curl` and `git` |
29+
| `make examples` | Run all examples | `go` |
30+
31+
## Features
32+
### Node
33+
* [NewNode](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#NewNode)
34+
* [AddNext](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Node.AddNext)
35+
* [Backtrack](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Node.Backtrack)
36+
* [Get](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Node.Get)
37+
* [GetStructure](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Node.GetStructure)
38+
* [IsLeaf](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Node.IsLeaf)
39+
* [IsRoot](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Node.IsLeaf)
40+
41+
### Tree
42+
* [New](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#New)
43+
* [Add](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Tree.Add)
44+
* [AddRoot](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Tree.AddRoot)
45+
* [Backtrack](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Tree.Backtrack)
46+
* [Get](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Tree.Get)
47+
* [GetRoot](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Tree.GetRoot)
48+
* [GetStructure](https://pkg.go.dev/github.com/johnfercher/tree/pkg/tree#Tree.GetStructure)
49+
1950
## Example
2051

2152
```golang

0 commit comments

Comments
 (0)