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

Update README.md #24

Merged
merged 4 commits into from
Jan 26, 2023
Merged

Update README.md #24

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
868bddd
Update README.md
tinytb Jan 23, 2023
3a07a45
docs: plug Helia Demo Day
tinytb Jan 23, 2023
b05ba31
docs: invite readers to have a look at the PR(s)
tinytb Jan 23, 2023
2dd50fa
Update README.md
tinytb Jan 25, 2023
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
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
<h3 align="center">An implementation of IPFS in JavaScript.</h3>
# Helia — 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.
This project is pre-alpha and is currently in development. An initial v1 release is planned for [late Q1 2023](/ROADMAP.md#late-q1-march). Helia is being built in the open; community contributors are welcome!

The core of IPFS is the [Files API](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md), which will likewise be implemented in Helia. These initial building blocks are in development now; have a look at this repo's PR(s). For more info about Helia, please see the [Roadmap](https://github.com/ipfs/helia/issues/5) and the [Manifesto](MANIFESTO.md).
Comment on lines +5 to +7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One roadmap links to #5 and one links to ./ROADMAP.md. Should we consolidate them?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#5 is where readers can leave comments. #5 links to ROADMAP.md, so I suppose #5 should be the place to go.

Comment on lines +5 to +7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One roadmap links to #5 and one links to ./ROADMAP.md. Should we consolidate them?


We are also sharing about the progress so far, and discussing how you can get involved, at [Helia Demo Day](https://lu.ma/helia) every couple weeks. We'd love to see you there!

## Table of Contents <!-- omit in toc -->

Expand All @@ -27,11 +31,11 @@ For more information, see the [State of IPFS in JS (blog post)](https://blog.ipf

## Roadmap

The roadmap can be found here: https://github.com/ipfs/pomegranate/issues/5
Please find and comment on [the Roadmap here](https://github.com/ipfs/helia/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).
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

Expand Down