Update the readme and document the public API, aspiring to be at least as good as purescript-pathy.

Example reproducer: C:\foo\bar This will not parse as an absolute path. Basically, PathCodec hard-assumes POSIX-style paths, despite being nominally parametric in its path semantics.

https://github.com/quasar-analytics/quasar/blob/master/mongodb/src/test/scala/quasar/physical/mongodb/collection.scala#L156

Adding sizeMin = 2 is required to avoid a case where the path generator only uses size = 1. Without this, all paths and all path names are sized to exactly 1, with no variation. With the parameter, everything appears to be randomly distributed.

I want to use pathy for the path part in the URI.
currently I only have access to

def currentDir[S]: Path[Rel, Dir, S] = Current
def rootDir[S]: Path[Abs, Dir, S] = Root

something like:

def current[T, S]: Path[Rel, T, S] = Current
def root[T, S]: Path[Abs, T, S] = Root

would be useful.

PathCodec's parse methods ignore directories called ., which is really a posix-specific feature and doesn't make sense for other codecs.

Much worse, parsing a file called . will actually produce a path with a non-sensical type:

@ posixCodec.parseAbsFile("/foo/bar/.").map(posixCodec.unsafePrintPath)
res1: Option[String] = Some(/foo/bar/)

Should be able to release directly from a CI build once it has been deemed worthy of release.

Need to get pathy building on CI server.

Same bug as purescript-contrib/purescript-pathy#5