Specifications (specs)
This repository contains the specs for InterPlanetary Linked Data (IPLD).
Work In Progress
Warning: this is a work in progress. IPLD is a young body of work and we want to get it right. We will continue to evaluate and re-think pieces.
Specs are not finished yet. We use the following tag system to identify their state:
- this spec is a work-in-progress, it is likely not even complete.
- this spec is a rough draft and will likely change substantially.
- this spec is believed to be close to final. Minor changes only.
- this spec is likely to improve, but not change fundamentally.
- this spec will not change.
Nothing in this spec repository is permanent yet. The most important pieces of IPLD are now reliable or stable. Many subsystems remain as draft.
Note that, as in many IPFS repositories, most of the work is happening in the issues or in active pull requests. Go take a look!
Specs
The specs contained in this repository are:
IPLD:
- IPLD
- IPLD Selectors
- IPLD Transformations
Maintainers
Contribute
Suggestions, contributions, criticisms are welcome. Though please make sure to familiarize yourself deeply with IPLD and IPFS, the models it adopts, and the principles it follows. Join in in the issues.
Please be aware that specs are really hard to design by committee. Treat this space like you would the workshop of an artist. Please suggest improvements, but please don't be disappointed if we say no to something. What we leave out is often more important than what we add in.
Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to IPLD are subject to the IPFS Code of Conduct.
Small note: If editing the README, please conform to the standard-readme specification.
License
This repository is only for documents. All of these are licensed under the CC-BY-SA 3.0 license, © 2016 Protocol Labs Inc.