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

Jump to bottom

docs: update README #9

Merged
merged 2 commits into from
Oct 28, 2022
Merged

docs: update README #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e58aee0
docs: update README
tinytb Oct 28, 2022
577af7f
docs: link to info about why the name is not ipfs
tinytb Oct 28, 2022
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
44 changes: 42 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
# Pomegranate
<h3 align="center">An implementation of IPFS in JavaScript.</h3>

> 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 <!-- omit in toc -->

- [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.