diff options
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | ecosystem.md | 14 | ||||
| -rw-r--r-- | how-dat-works.md | 13 | ||||
| -rw-r--r-- | mkdocs.yml | 1 |
4 files changed, 16 insertions, 22 deletions
@@ -64,13 +64,3 @@ $ ls ~/.dat db config.json ``` - -## Dat dependency overview - -#### [hyperdrive](https://github.com/mafintosh/hyperdrive) - -The file sharing network dat uses to distribute files and data. A technical specification / discussion on how hyperdrive works is [available here](https://github.com/mafintosh/hyperdrive/blob/master/SPECIFICATION.md) - -#### [discovery-channel](https://github.com/maxogden/discovery-channel) - -This is the module dat uses to find peers on the local network or the internet who are sharing the same files and data that you are. diff --git a/ecosystem.md b/ecosystem.md new file mode 100644 index 0000000..fbd8929 --- /dev/null +++ b/ecosystem.md @@ -0,0 +1,14 @@ +## Implementations + +If you want to go deeper and see the implementations we are using in the [Dat command-line tool](https://github.com/maxogden/dat), here you go: + +- [dat](https://www.npmjs.com/package/dat) - the main command line tool that uses all of the below +- [discovery-channel](https://www.npmjs.com/package/discovery-channel) - discover data sources +- [discovery-swarm](https://www.npmjs.com/package/discovery-swarm) - discover and connect to sources +- [hyperdrive](https://www.npmjs.com/package/hyperdrive) - The file sharing network dat uses to distribute files and data. A technical specification / discussion on how hyperdrive works is [available here](https://github.com/mafintosh/hyperdrive/blob/master/SPECIFICATION.md) +- [hypercore](https://www.npmjs.com/package/hypercore) - exchange lwo level binary blocks with many sources +- [bittorrent-dht](https://www.npmjs.com/package/bittorrent-dht) - use the Kademlia Mainline DHT to discover sources +- [dns-discovery](https://www.npmjs.com/package/dns-discovery) - use DNS name servers and Multicast DNS to discover sources +- [utp-native](https://www.npmjs.com/package/utp-native) - UTP protocol implementation +- [rabin](https://www.npmjs.com/package/rabin) - Rabin fingerprinter stream +- [merkle-tree-stream](https://www.npmjs.com/package/merkle-tree-stream) - Used to construct Merkle trees from chunks diff --git a/how-dat-works.md b/how-dat-works.md index 533f509..2db5930 100644 --- a/how-dat-works.md +++ b/how-dat-works.md @@ -52,15 +52,4 @@ Because Dat is built on a foundation of strong cryptographic data integrity and ## Implementations -This covered a lot of ground. If you want to go deeper and see the implementations we are using in the [Dat command-line tool](https://github.com/maxogden/dat), here you go: - -- [dat](https://www.npmjs.com/package/dat) - the main command line tool that uses all of the below -- [discovery-channel](https://www.npmjs.com/package/discovery-channel) - discover data sources -- [discovery-swarm](https://www.npmjs.com/package/discovery-swarm) - discover and connect to sources -- [hyperdrive](https://www.npmjs.com/package/hyperdrive) - exchange sets of files with many sources -- [hypercore](https://www.npmjs.com/package/hypercore) - exchange lwo level binary blocks with many sources -- [bittorrent-dht](https://www.npmjs.com/package/bittorrent-dht) - use the Kademlia Mainline DHT to discover sources -- [dns-discovery](https://www.npmjs.com/package/dns-discovery) - use DNS name servers and Multicast DNS to discover sources -- [utp-native](https://www.npmjs.com/package/utp-native) - UTP protocol implementation -- [rabin](https://www.npmjs.com/package/rabin) - Rabin fingerprinter stream -- [merkle-tree-stream](https://www.npmjs.com/package/merkle-tree-stream) - Used to construct Merkle trees from chunks +This covered a lot of ground. If you want to go deeper and see the implementations we are using in the [Dat command-line tool](https://github.com/maxogden/dat), go to the [Dependencies](dependencies.md) page @@ -3,6 +3,7 @@ theme: readthedocs pages: - Home: 'index.md' - 'How Dat Works': 'how-dat-works.md' +- 'Depenencies and Implementations': 'ecosystem.md' - Meta: - 'Changelog': 'meta/changelog.md' - 'Collaborators': 'meta/collaborators.md' |