mirror of
https://github.com/ipfs/ipfs
synced 2024-09-16 09:11:34 +02:00
Reorganized README headings
Part of ipfs/community#124. Reorganized them a bit.
This commit is contained in:
Richard Littauer
parent
7314c1b641
commit
562b3c4b52
60
README.md
60
README.md
@ -4,28 +4,24 @@
|
||||
|
||||
Welcome to IPFS! Why not [watch a video demo](https://www.youtube.com/watch?v=8CMxDNuuAiQ) to get started?
|
||||
|
||||
## Table of Contents (links)
|
||||
## Table of Contents
|
||||
|
||||
- [IPFS Overview](#overview) and [Quick Summary](#quick-summary)
|
||||
- [How IPFS Works](#how-ipfs-works)
|
||||
- [Papers](#ipfs-papers), [Talks, and Demos](#ipfs-talks)
|
||||
- [About IPFS](#more-about-ipfs)
|
||||
- [Current State](#current-state-of-ipfs)
|
||||
- [Alpha Distribution](#alpha-distribution)
|
||||
- [Security Issues and Disclosures](#security-issues-and-disclosures)
|
||||
- [Getting Started](#alpha-distribution) with the IPFS alpha distribution
|
||||
- [Install IPFS](https://ipfs.io/docs/install/)
|
||||
- [Setup IPFS](https://ipfs.io/docs/getting-started/#init-the-repo)
|
||||
- [Going Online](https://ipfs.io/docs/getting-started/#going-online)
|
||||
- [Project and Community](#project-and-community)
|
||||
- [FAQs: Frequently Asked Questions](https://github.com/ipfs/faq)
|
||||
- [Support and Getting Help!](https://github.com/ipfs/support)
|
||||
- [Sprints + Project Management](https://github.com/ipfs/pm)
|
||||
- [Contributing Guidelines](https://github.com/ipfs/community/blob/master/contributing.md)
|
||||
- [Project Links](#project-links)
|
||||
- [Protocol Implementations](#protocol-implementations)
|
||||
- [API Client Libraries](#api-client-libraries)
|
||||
- [Project Directory](#project-directory)
|
||||
- [Overview](#overview)
|
||||
- [Quick Summary](#quick-summary)
|
||||
- [How IPFS Works](#how-ipfs-works)
|
||||
- [IPFS Papers](#ipfs-papers)
|
||||
- [IPFS Talks](#ipfs-talks)
|
||||
- [More About IPFS](#more-about-ipfs)
|
||||
- [Current State of IPFS](#current-state-of-ipfs)
|
||||
- [Alpha Distribution](#alpha-distribution)
|
||||
- [Security Issues and Disclosures](#security-issues-and-disclosures)
|
||||
- [Project and Community](#project-and-community)
|
||||
- [Project Links](#project-links)
|
||||
- [Protocol Implementations](#protocol-implementations)
|
||||
- [API Client Libraries](#api-client-libraries)
|
||||
- [Project Directory](#project-directory)
|
||||
- [Other Community Resources](#other-community-resources)
|
||||
- [License](#license)
|
||||
|
||||
## Overview
|
||||
|
||||
@ -90,13 +86,13 @@ IPFS has a name service:
|
||||
|
||||
To learn more about how IPFS works take a look at the [Papers](#ipfs-papers) or [Talks](#ipfs-talks). You can also explore the [Specs](https://github.com/ipfs/specs) in writing.
|
||||
|
||||
#### IPFS Papers
|
||||
### IPFS Papers
|
||||
|
||||
- [IPFS - Content Addressed, Versioned, P2P File System (draft 3)](https://github.com/ipfs/ipfs/blob/master/papers/ipfs-cap2pfs/ipfs-p2p-file-system.pdf?raw=true)
|
||||
- [Specifications](https://github.com/ipfs/specs) (work in progress)
|
||||
- see also: https://github.com/ipfs/papers
|
||||
|
||||
#### IPFS Talks
|
||||
### IPFS Talks
|
||||
|
||||
This is a short selection of introductory talks. In time we will collect more here.
|
||||
|
||||
@ -112,7 +108,7 @@ The IPFS project seeks to evolve the infrastructure of the Internet and the Web,
|
||||
|
||||
### Current State of IPFS
|
||||
|
||||
#### IPFS is a work in progress!
|
||||
**IPFS is a work in progress!**
|
||||
|
||||
Please note that IPFS is a work in progress. It is an ambitious plan to make the internet more free, open, secure, and high performance. It builds on the good ideas of numerous battle-tested distributed systems.
|
||||
|
||||
@ -140,16 +136,18 @@ If the issue is a protocol weakness that cannot be immediately exploited or some
|
||||
|
||||
## Project and Community
|
||||
|
||||
[](https://github.com/ipfs/community/blob/master/contributing.md)
|
||||
|
||||
The IPFS Project is now very large, with hundreds of contributors in our community. You are invited to join it! Here are some links to our communication channels:
|
||||
|
||||
- [FAQs: Frequently Asked Questions](https://github.com/ipfs/faq)
|
||||
- [Support and Getting Help!](https://github.com/ipfs/faq)
|
||||
- [Support and Getting Help!](https://github.com/ipfs/support)
|
||||
- [Sprints and Project Management](https://github.com/ipfs/pm)
|
||||
- [Contributing Guidelines](https://github.com/ipfs/community/blob/master/contributing.md)
|
||||
|
||||
You can also find our community on:
|
||||
|
||||
- IRC: [#ipfs on chat.freenode.net](http://chat.ipfs.io) for live help + some dev discussions ([Logs](https://botbot.me/freenode/ipfs/))
|
||||
- IRC: [#ipfs on chat.freenode.net](http://chat.ipfs.io) for live help and some dev discussions ([Logs](https://botbot.me/freenode/ipfs/))
|
||||
- Google Group: [ipfs-users@groups.google.com](https://groups.google.com/forum/#!forum/ipfs-users) (low traffic)
|
||||
- Twitter: [@IPFSbot](https://twitter.com/ipfsbot) for some news.
|
||||
|
||||
@ -160,7 +158,7 @@ The IPFS Project is big -- there are many subprojects and related efforts. We wi
|
||||
|
||||
For a community-curated lists of awesome projects using IPFS, check out [awesome-ipfs](https://github.com/ipfs/awesome-ipfs)!
|
||||
|
||||
#### Protocol Implementations
|
||||
### Protocol Implementations
|
||||
|
||||
| Language | Project | Completeness |
|
||||
|----------|---------|--------------|
|
||||
@ -170,7 +168,7 @@ For a community-curated lists of awesome projects using IPFS, check out [awesome
|
||||
|
||||
If you would you like to start your own language implementation of IPFS, check out the [IPFS Implementation Guide](https://github.com/ipfs/specs/blob/master/overviews/implement-ipfs.md), and the [Specifications](https://github.com/ipfs/specs). The specs are still evolving, but the core formats are stable and can be built on. Make sure to post an issue if you would like to start an effort, as many people have expressed interest in contributing to new implementations.
|
||||
|
||||
#### API Client Libraries
|
||||
### API Client Libraries
|
||||
|
||||
| Language | Client Library | Completeness |
|
||||
|----------|----------------|--------------|
|
||||
@ -279,7 +277,7 @@ We have a status board that checks all IPFS repositories for CI, Readmes, test c
|
||||
* [refs-denylists-dmca](https://github.com/ipfs/refs-denylists-dmca) - DMCA takedown notices for the IPFS Public Gateway.
|
||||
* [refs-solarnet-storage](https://github.com/ipfs/refs-solarnet-storage) - Inventory of content archived on Solarnet storage hosts.
|
||||
|
||||
## Other Community Resources
|
||||
### Other Community Resources
|
||||
|
||||
* [examples](https://github.com/ipfs/examples) - Examples on how to use go-ipfs.
|
||||
* [awesome-ipfs](https://github.com/ipfs/awesome-ipfs) - Useful resources for using IPFS and building things on top of it.
|
||||
@ -343,3 +341,7 @@ Many more exist, but we will endeavor to find them and add them here.
|
||||
* [js-ipfs-unixfs](https://github.com/ipfs/js-ipfs-unixfs) - JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG)
|
||||
* [js-libp2p-ipfs-browser](https://github.com/ipfs/js-libp2p-ipfs-browser) - libp2p build (module) used in js-ipfs when running it on the browser
|
||||
* [js-libp2p-ipfs](https://github.com/ipfs/js-libp2p-ipfs) - libp2p build (module) used in js-ipfs
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
# IPFS Roadmap
|
||||
|
||||
These are various challenges and milestones in the IPFS Project. They are not ordered in any way at the moment, merely grouped.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user