This PR contains the work done to address the issue #7, related to documenting the source code that would be used for other developers.
To provide further details about the work done:
- [x] restructured the hierarchy of some models that are related to the `Amiibo` model;
- [x] written documentation for the `AmiiboService` service;
- [x] written documentation for the `AmiiboFilter` and `KeyNameFilter` filters;
- [x] written documentation for the `Amiibo`, `KeyName`, `LastUpdated` and children model;
- [x] written documentation for the `AmiiboClientError` error;
- [x] written documentation for the README file.
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #10
Javier Cicchelli
c4a25afad4