IPLD Specifications

This repository contains the specs for InterPlanetary Linked Data (IPLD).

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. As in many IPLD repositories, most of the work is happening in the issues or in active pull requests. Go take a look!

Documents

• Roadmap
• Specifications:
  • IPLD - spec about the data model, pointers and link formats
  • IPLD Selectors - spec about simple language to select multiple unknown nodes in a graph
  • IPLD Transformations - spec about the language to trasform an IPLD graph into another
  • CID (Content IDentifier)
  • IPLD Formats - interface definition for adding support to different formats
  • CAR - Content Addressable Archives

Discussion

Join the discussion for:

• Specs - https://github.com/ipld/specs/issues
• General IPLD - https://github.com/ipld/ipld/issues
• JavaScript Implementation - https://github.com/ipld/js-ipld/issues
• Golang Implementation - https://github.com/ipfs/go-ipld-format

Weekly Hangout

TBA soon™

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.