Skip to content

Commit

Permalink
docs: Update README.md (#34)
Browse files Browse the repository at this point in the history
Move the purpose/goals up top
Make clearer how to get involved
Use markdown TOC generator

---------

Co-authored-by: Alex Potsides <alex@achingbrain.net>
  • Loading branch information
BigLep and achingbrain authored Feb 24, 2023
1 parent d15d76c commit 031ca73
Showing 1 changed file with 24 additions and 23 deletions.
47 changes: 24 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,50 +15,51 @@
## Table of contents <!-- omit in toc -->

- [Structure](#structure)
- [Purpose and goals](#purpose-and-goals)
- [Project status](#project-status)
- [Name](#name)
- [Background](#background)
- [Roadmap](#roadmap)
- [Get involved](#get-involved)
- [API Docs](#api-docs)
- [Structure](#structure)
- [Name](#name)
- [License](#license)
- [Contribute](#contribute)

## Structure

- [`/packages/helia`](./packages/helia) An implementation of IPFS in JavaScript
- [`/packages/interface`](./packages/interface) The Helia API
- [`/packages/interop`](./packages/interop) Interop tests for Helia
## Purpose and goals

## Project status
A lean, modular, and modern implementation of IPFS for the prolific JS and browser environments.

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!
See the [Manifesto](./MANIFESTO.md) and the [State of IPFS in JS blog post frpom 202210](https://blog.ipfs.tech/state-of-ipfs-in-js/) for more info.

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).
## Project status

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!
As of early 2023, this project is pre-alpha and is currently in development. These initial building blocks are in development now; have a look at this repo's PR(s). An initial v1 release is planned for [late Q1 2023](/ROADMAP.md#late-q1-march).

## Name
## Roadmap

Helia (*HEE-lee-ah*) is the Latin spelling of Ἡλιη -- in Greek mythology, one of the [Heliades](https://www.wikidata.org/wiki/Q12656412): the daughters of the sun god Helios. When their brother Phaethon died trying to drive the sun chariot across the sky, their tears of mourning fell to earth as amber, which is yellow (sort of), and so is JavaScript. They were then turned into [poplar](https://en.wiktionary.org/wiki/poplar) trees and, well, JavaScript is quite popular.
Please find and comment on [the Roadmap here](https://github.com/ipfs/helia/issues/5).

In Oct–Dec 2022, IP Stewards [sought](https://github.com/ipfs/pomegranate/issues/3) community input for the name of this project. After considering 20 suggestions and holding a couple of polls, the name **Helia** was chosen. Here's [why it's not named IPFS](https://github.com/ipfs/ipfs/issues/470).
## Get involved

## Background
* We are sharing about the progress at periodic [Helia Demos](https://lu.ma/helia). This is a good place to find out the latest and learn of ways to get involved. We'd love to see you there!
* Pick up one of the [issues](https://github.com/ipfs/helia/issues).
* Come chat in Filecoin Slack #ip-js. (Yes, we should bridge this to other chat enviornments. Please comment [here](https://github.com/ipfs/helia/issues/33) if you'd like this.)

This project aims to build a lean, modular, and modern implementation of IPFS, the InterPlanetary File System.
## API Docs

For more information, see the [State of IPFS in JS (blog post)](https://blog.ipfs.tech/state-of-ipfs-in-js/).
- <https://ipfs.github.io/helia>

## Roadmap
## Structure

Please find and comment on [the Roadmap here](https://github.com/ipfs/helia/issues/5).
- [`/packages/helia`](./packages/helia) An implementation of IPFS in JavaScript
- [`/packages/interface`](./packages/interface) The Helia API
- [`/packages/interop`](./packages/interop) Interop tests for Helia

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)!
## Name

## API Docs
Helia (*HEE-lee-ah*) is the Latin spelling of Ἡλιη -- in Greek mythology, one of the [Heliades](https://www.wikidata.org/wiki/Q12656412): the daughters of the sun god Helios. When their brother Phaethon died trying to drive the sun chariot across the sky, their tears of mourning fell to earth as amber, which is yellow (sort of), and so is JavaScript. They were then turned into [poplar](https://en.wiktionary.org/wiki/poplar) trees and, well, JavaScript is quite popular.

- <https://ipfs.github.io/helia>
In Oct–Dec 2022, [PL EngRes IP Stewards](https://pl-strflt.notion.site/IP-Stewards-9b65f88602474557b5d6f644194e941f) [sought community input](https://github.com/ipfs/pomegranate/issues/3) for the name of this project. After considering 20 suggestions and holding a couple of polls, the name **Helia** was chosen. Here's [why "ipfs" is not in the name](https://github.com/ipfs/ipfs/issues/470).

## License

Expand Down

0 comments on commit 031ca73

Please sign in to comment.