diff --git a/README.md b/README.md index eb04f5c9..7341ac83 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ -# Pomegranate +

An implementation of IPFS in JavaScript.

-> An implementation of IPFS in JavaScript +### Project status + +This project is pre-alpha and is planned for development in late 2022, with an initial "v1" release in [late Q1 2023](/ROADMAP.md#late-q1-march). The project will be built in the open. Community contributors are welcome. + +## Table of Contents + +- [Name](#name) +- [Background](#background) +- [Roadmap](#roadmap) +- [Contribute](#contribute) +- [License](#license) + - [Contribution](#contribution) + +## Name + +This project has not yet been named. It will [not](https://github.com/ipfs/ipfs/issues/470) be named IPFS. "Pomegranate" is a temporary codename. Please [propose a name, and/or vote for a name idea here](https://github.com/ipfs/pomegranate/issues/3). + +## Background + +This project aims to build a lean, modular, modern implementation of IPFS, the Interplanetary File System. + +For more information, see the [State of IPFS in JS (blog post)](https://blog.ipfs.tech/state-of-ipfs-in-js/). + +## Roadmap + +The roadmap can be found here: https://github.com/ipfs/pomegranate/issues/5 + +## Contribute + +This IPFS implementation in JavaScript is a work in progress. [Here are some ways you can help](https://blog.ipfs.tech/state-of-ipfs-in-js/#%F0%9F%A4%9D-ways-you-can-help). + +## License + +Licensed under either of + + * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0) + * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT) + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.