Skip to content

Commit

Permalink
chore: add readme
Browse files Browse the repository at this point in the history
Signed-off-by: gfanton <[email protected]>
  • Loading branch information
gfanton committed Jun 16, 2023
1 parent 8cabf09 commit 39b1e4c
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
test:
go test -v -race ./...
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<h1 align="center">
<br>
<img src="https://berty.tech/img/berty.svg" alt="Yolo - The Berty Project" height="300px">
<br>
</h1>

<h3 align="center">Berty is a secure peer-to-peer messaging app that works with or without internet access, cellular data or trust in the network</h3>

<p align="center">
<a href="https://berty.tech"><img alt="Made by Berty Technologies" src="https://assets.berty.tech/files/badge--10.svg" /></a>
<a href="https://crpt.fyi/berty-discord"><img alt="discord" src="https://img.shields.io/badge/discord-gray?logo=discord" /></a>
<a href="https://github.com/berty"><img alt="github" src="https://img.shields.io/badge/@berty-471961?logo=github" /></a>
<a href="https://twitter.com/berty"><img alt="twitter" src="https://img.shields.io/twitter/follow/berty?label=%40berty&style=flat&logo=twitter" /></a>
<a href="https://pkg.go.dev/berty.tech/go-libp2p-mock?tab=subdirectories"><img alt="go.dev reference" src="https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white" /></a>
<a href="https://github.com/berty/go-libp2p-mock/releases"><img alt="GitHub release" src="https://img.shields.io/github/v/release/berty/go-libp2p-mock" /></a>
</p>

This repository hosts a fork of the `github.com/go-libp2p/p2p/net/mock` subpackage, formerly maintained by libp2p. It provides a mock network interface for testing purposes within the go-libp2p ecosystem.

### Troubleshooting

_(please use [issues](https://github.com/berty/go-libp2p-mock/issues)

### Testing

to test this package, use `make test`

## Contributing

[![Contribute to Berty](https://assets.berty.tech/files/contribute-contribute_v2--Contribute-berty-ultra-light.gif)](https://github.com/berty/community)

If you want to help out, please see [CONTRIBUTING.md](./CONTRIBUTING.md).

This repository falls under the Berty [Code of Conduct](https://github.com/berty/community/blob/master/CODE_OF_CONDUCT.md).

You can contact us on the [`#dev-💻`](https://crpt.fyi/berty-dev-discord) channel on [discord](https://crpt.fyi/berty-discord).

## License

Dual-licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) and [MIT](https://opensource.org/licenses/MIT) terms.

`SPDX-License-Identifier: (Apache-2.0 OR MIT)`

See the [COPYRIGHT](./COPYRIGHT) file for more details.

0 comments on commit 39b1e4c

Please sign in to comment.