Skip to content

Commit 8824bf2

Browse files
committed
README: convert to Markdown, as pkg.go.dev doesn't play well with org-mode
1 parent 27a085a commit 8824bf2

File tree

2 files changed

+28
-27
lines changed

2 files changed

+28
-27
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# go-binarytree
2+
3+
A simple implementation of [Binary Trees](https://en.wikipedia.org/wiki/Binary_tree) in Go.
4+
5+
## Installation
6+
7+
Install `go-binarytree` by executing the following command.
8+
9+
``` shell
10+
go get -v gopkg.in/dnaeon/go-binarytree.v1
11+
```
12+
13+
## Usage
14+
15+
See the included [test cases](./binarytree_test.go) for some examples.
16+
17+
## Tests
18+
19+
Run the tests.
20+
21+
``` shell
22+
make test
23+
```
24+
25+
## License
26+
27+
`go-binarytree` is Open Source and licensed under the [BSD
28+
License](http://opensource.org/licenses/BSD-2-Clause).

README.org

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)