Skip to content

Commit

Permalink
moving forward
Browse files Browse the repository at this point in the history
  • Loading branch information
dignifiedquire committed Feb 17, 2023
1 parent 48748c4 commit 6527ee4
Showing 1 changed file with 3 additions and 41 deletions.
44 changes: 3 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,6 @@
# iroh

[![crates.io](https://img.shields.io/crates/v/iroh.svg?style=flat-square)](https://crates.io/crates/iroh)
[![Released API docs](https://img.shields.io/docsrs/iroh?style=flat-square)](https://docs.rs/iroh)
[![MIT/Apache-2.0 licensed](https://img.shields.io/crates/l/iroh?style=flat-square)](./LICENSE-MIT)
[![CI](https://img.shields.io/github/workflow/status/n0-computer/iroh/Continuous%20integration?style=flat-square)](https://github.com/n0-computer/iroh/actions?query=workflow%3A%22Continuous+integration%22)
Something new is coming very soon :)
The old code base has moved to https://github.com/n0-computer/beetle

Iroh is a next-generation implementation of the Interplanetary File System ([IPFS](https://ipfs.io)) for Cloud & Mobile platforms.

IPFS is a networking protocol for exchanging _content-addressed_ blocks of immutable data. “Content-addressed” means referring to data by the *hash of its content*, which makes the reference unique and verifiable. These two properties make it possible to get data from *any* node in the network that speaks the IPFS protocol, including IPFS content being served by other implementations of IPFS.

This repo is a common core for three distributions of iroh:

- **Iroh Cloud:** core features of iroh split into configurable microservices, optimized for running at datacenter scale.
- **Iroh One:** A select set of iroh cloud features packaged as a single binary for simplified deployment.
- **Iroh Mobile:** iOS & Android libraries that bring efficient data distribution to mobile apps.

Here is an [install guide](https://iroh.computer/install).

## Working on Iroh
Check out the [CONTRIBUTOR docs](./CONTRIBUTOR.md) to get familiar with ways you can contribute to the Iroh project. The [DEVELOPERS docs](./DEVELOPERS.md) will help you get starting with building and developing Iroh.

## Benchmarks

A full suite of automated benchmarks is in the works. [this talk](https://www.youtube.com/watch?v=qPBR2K2X6cs&t=161s) goes into some early numbers.

## Who's behind this?

[Iroh](https://iroh.computer) is built & maintained by [number 0](https://n0.computer). We're a founder-backed startup hell-bent on building efficient distributed systems software.

## License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br />

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>
For more details please take a look at https://n0.computer/blog/a-new-direction-for-iroh/

0 comments on commit 6527ee4

Please sign in to comment.