Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: experimental messaging from readme #1426

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: experimental messaging from readme #1426

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,12 @@

Trin is a Rust implementation of a [Portal Network](https://github.com/ethereum/portal-network-specs) client.

The Portal Network is still in the research phase, and this client is experimental.

**Do not rely on Trin in a production setting.**


## How to use Trin

Check out the [Trin book](https://ethereum.github.io/trin) to quickly get up and running with Trin.

> **NOTE**: This project uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). If you just cloned the project, be sure to run: `git submodule update --init`. See our dedicated [page](https://ethereum.github.io/trin/developers/contributing/git/submodules.html) for more info.

## Experimental Status

Trin is a prototype Portal Network client. This implementation and the Portal Network specifications will continue to co-evolve.

In this stage of development, Trin lacks comprehensive data validation.

## Want to help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our
Expand Down