Skip to content

Commit

Permalink
chore: remove only unix + experimental messaging from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KolbyML committed Jan 11, 2025
1 parent 308b7c1 commit e5c423b
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 15 deletions.
14 changes: 0 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +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.**

**NOTE: Unix-only**

Trin currently only runs on Unix-based platforms (Linux, macOS). We plan to eventually implement support for Windows, but until then do not expect any support for issues on Windows.

## 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

0 comments on commit e5c423b

Please sign in to comment.