diff --git a/README.md b/README.md index 4c3b124..0b7c3bb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,27 @@ # ipfs glossary -A collection of descriptions for terms related to ipfs and surrounding techs -### To Do +[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) +[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/) +[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) +[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) + +> A collection of descriptions for terms related to ipfs and surrounding techs + +## Table of Contents + +- [Terms](#terms) + - [Protocol](#protocol) + - [Hash Function](#hash-function) + - [DHT (Distributed Hash Table)](#dht-distributed-hash-table) + - [TCP](#tcp) + - [UDP](#udp) + - [Merkledag](#merkledag) + - [unixfs](#unixfs) +- [Contribute](#contribute) + - [Want to hack on IPFS?](#want-to-hack-on-ipfs) +- [License](#license) + +## Terms These terms are not yet defined, but have been suggested as good terms to work on. Please define them if you can! @@ -29,6 +49,19 @@ TCP is a protocol that is used for a huge portion of web traffic. It guarantees #### UDP UDP is a protocol that does not have the same guarantees as TCP. Data sent can go missing, or arrive in the wrong order. +### Merkledag +TODO + #### unixfs Merkle-dag based data structures for representing unix files, directories, and symlinks + +## Contribute + +Feel free to join in. Just edit this main README file in a PR, or open an [issue](https://github.com/ipfs/glossary/issues)! + +This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). + +### Want to hack on IPFS? + +[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)