Merge pull request #5 from millette/notes

Notes on dat URLs.

Author: Joe Hand

README.md

@@ -43,6 +43,47 @@ Resolution order:
 3. Check JSON request response for `key`
 4. Dat-DNS resolution via [dat-dns](https://github.com/datprotocol/dat-dns)
 
+## Refering to dats
+Trying to tighten up a bit dat-link-resolve (and its dependencies dat-dns and dat-decode). I am noticing a few inconsistencies as I'm writing dat-shell.
+
+Ideally, I'd like to launch dat-shell like this:
+```sh
+$ dat-shell dat://40a7f6b6147ae695bcbcff432f684c7bb5291ea339c28c1755896cdeb80bd2f9+5/path4
+```
+
+and have it open the dat at version 5 and change directory to /path4.
+
+Currently ```dat-shell google-fonts-kewitz.hashbase.io/fonts/``` [fails somewhere in dat-link-resolve](https://github.com/millette/dat-shell/issues/5).
+
+### Examples
+Note that dat-link-resolve also supports other methods, such as detection of dat keys in paths and http headers.
+
+#### Simplest
+* Plain: 40a7f6b6147ae695bcbcff432f684c7bb5291ea339c28c1755896cdeb80bd2f9
+* DNS: pfrazee.hashbase.io
+
+#### With version
+* Plain: 40a7f6b6147ae695bcbcff432f684c7bb5291ea339c28c1755896cdeb80bd2f9+5
+* DNS: pfrazee.hashbase.io+5
+
+#### With scheme
+* https: https://40a7f6b6147ae695bcbcff432f684c7bb5291ea339c28c1755896cdeb80bd2f9/
+* dat: dat://pfrazee.hashbase.io
+
+#### With path
+* https: 40a7f6b6147ae695bcbcff432f684c7bb5291ea339c28c1755896cdeb80bd2f9/path1
+* dat: pfrazee.hashbase.io/path2
+
+#### Combinations
+* 40a7f6b6147ae695bcbcff432f684c7bb5291ea339c28c1755896cdeb80bd2f9+5/path3
+* dat://40a7f6b6147ae695bcbcff432f684c7bb5291ea339c28c1755896cdeb80bd2f9+5/path4
+* https://40a7f6b6147ae695bcbcff432f684c7bb5291ea339c28c1755896cdeb80bd2f9/path5 [(^1)][]
+* https://pfrazee.hashbase.io+5/path6 [(^2)][]
+
+### Notes
+1. browsers expect http and https schemes with traditional hostname, not a dat key
+2. browsers expect http and https schemes with traditional hostname, no +5 (version) support
+
 ## Contributing
 
 Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.
@@ -57,3 +98,5 @@ Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md
 [travis-url]: https://travis-ci.org/joehand/dat-link-resolve
 [standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
 [standard-url]: http://npm.im/standard
+[(^1)]: <#notes>
+[(^2)]: <#notes>