Since there is lot of documentation, I would suggest having only a synopsis in the README file and linking to the package docs for the rest (to avoid duplication).