Skip to content

Commit c31b9c7

Browse files
authored
chore: add note about derived work + example + license (#12)
chore: add note about derived work + example + license
2 parents 9e67600 + 501c44c commit c31b9c7

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,18 @@
3636
<a href="https://berty.tech">berty.tech</a> •
3737
<a href="https://github.com/berty">GitHub</a>
3838
</b></p>
39+
40+
> An append-only log on IPFS.
41+
42+
[ipfs-log](https://github.com/orbitdb/ipfs-log/) was originally created for [orbit-db](https://github.com/orbitdb/orbit-db) - a distributed peer-to-peer database on [IPFS](https://github.com/ipfs/ipfs). This library intends to provide a fully compatible port of the JavaScript version in Go.
43+
44+
The majority of this code was vastly derived from the JavaScript's [ipfs-log](https://github.com/orbitdb/ipfs-log) library.
45+
46+
## Usage
47+
48+
See the `example` package on [GoDoc](https://godoc.org/berty.tech/go-ipfs-log/example#example-package--LogAppend)
49+
50+
## Licensing
51+
52+
*go-ipfs-log* is licensed under the Apache License, Version 2.0.
53+
See [LICENSE](LICENSE) for the full license text.

0 commit comments

Comments
 (0)