The readme right now is kinda scary. There are a lot of complex code examples, and the glossary is gigantic. Instead, consider only showing the barebones installation instructions and description in the main readme, and moving the reference and full docs into a separate file or the repo wiki.
Example simple readme:
OBA API SDK
Small wrapper library that makes it easier to work with the OBA API.
Installation
npm install @maanlamp/oba-sdk
Usage
import SDK from "@maanlamp/oba-sdk";
const client = new sdk({
key: "abcdef123456"
});
client.search("banaan")
.then(console.log)
.catch(console.error);
The readme right now is kinda scary. There are a lot of complex code examples, and the glossary is gigantic. Instead, consider only showing the barebones installation instructions and description in the main readme, and moving the reference and full docs into a separate file or the repo wiki.
Example simple readme:
OBA API SDK
Small wrapper library that makes it easier to work with the OBA API.
Installation
Usage
Full SDK Docs
Team
@maanlamp 🌜💡
License
MIT etc etc