search

tenderlove / mmap

A wrapper around mmap
61 stars 14 forks source link

Include contents of `mmap.rd` into `README.rdoc` #9

Closed dmagliola closed 4 years ago

dmagliola commented 5 years ago

Currently, the gem's main README, or the docs generated with rake docs don't include a description of the interface, or much documentation at all.

The most useful documentation is in file mmap.rd which is not very obvious.

This change includes the contents of mmap.rd into README.rdoc, which is the main port of call for any user of a gem.