\n\n## Installation\n_This package is Isomorphic and Typescript ready_\n\n`npm install biketag`\n\n
\n\n## How to include it in your projects\n\nThe library is a default export, as well as a named class export `BikeTagClient`. You can retrieve it from jsDeliver or npm, and it works in both the browser and nodejs.\n\n### Browser\n\nUsing jsDelivr CDN:\n\n```html\n\n```\n\nUsing unpkg CDN:\n\n```html\n\n```\n\n### CommonJS\n\nimport/require the module:\n```ts\n// Using import statement\nimport { BikeTagClient } from 'biketag'\n```\n\n```js\n// Using require()\nconst { BikeTagClient } = require('biketag')\n```\n\n---\n\n## Usage\n\n### Instantiate with or without credentials (browser):\n```js\n// if you have your clientKey/clientToken to retrieve an access token automatically, you can pass those in:\nconst client = new biketag({\n game: 'portland',\n clientKey: process.env.BIKETAG_CLIENT_KEY,\n clientToken: process.env.BIKETAG_CLIENT_TOKEN,\n})\n```\n\n### Instantiate with or without credentials (node):\n```ts\n// if you have Imgur credentials: clientId and clientSecret\nconst client = new BikeTagClient({\n game: 'portland',\n imgur: {\n clientId: process.env.IMGUR_CLIENT_ID,\n clientSecret: process.env.IMGUR_CLIENT_SECRET,\n }\n})\n```\n
\n\n### Configuration\n\nThe BikeTag API requires only the game to be set in the configuration in order to read BikeTag data. You can read more about specific configurations in the documentation: \n\n
\n\n### **⚠️ For brevity, the rest of the examples will leave out the import and/or instantiation step.**\n\n\n### Get Game Information\n\nYou can get game information by providing the name.\n\n```ts\n// retrieves the BikeTag game data 'portland' game\nconst biketagPortland = await client.game('portland')\n```\n\n### Get Tags\n\nYou can get tags one by one or all at once for a given game using the `getTag` and `getTags` methods. You can also explicitely set the data adapter to any of the configurable sources (biketag, imgur, sanity):\n\n```ts\n// retrieves the BikeTag game data 'portland' game\nconst biketagPortland = await client.game('portland')\n\n// retrieves the latest BikeTag posted for the 'portland' game from the most available API\nconst biketagPortlandCurrent = await client.getTag()\n\n// retrieves the BikeTag #1 for the 'portland' game from imgur adapter\nconst biketagPortland1 = await client.tags(1, { source: 'imgur' })\n\n// retrieves the all BikeTags for the 'portland' game from sanity adapter\nconst allPortlandTags = await client.tags(undefined, { source: 'sanity' })\n\n```\n\n### Get Players\n\nYou can get the players of a game by calling getPlayers\n\n```ts\n// retrieves the BikeTag player data 'portland' game\nconst biketagPortlandPlayers = await biketagAPI.getPlayers('portland')\n```\n\n
\n\n## Credits\n\n
\n\nThis project is heavily influenced by the [node-imgur][node-imgur] package, the Imgur API and it's documentation, and Sanity.IO's javascript client.\n\nUsing the typescript library configured and developed on the node-imgur v2 project: https://github.com/kaimallea/node-imgur, this package comes bundled with testing using jest and automated releases using github actions. Many thanks to Kaimallea for collaborating with me on the imgur API because I learned so much along the way!\n\nSupport the BikeTag Project on [GitHub][github], [Patreon][patreon], or directly by going out and playing a round of [BikeTag in your city](https://biketag.org)!\n\n[github]: https://github.com/sponsors/KenEucker\n[patreon]: https://patreon.com/BikeTag\n[node-imgur]: https://github.com/kaimallea/node-imgur\n[sanity]: https://www.sanity.io/docs/api-versioning\n[imgur]: https://www.npmjs.com/package/imgur/v/next\n\n![Alt](https://repobeats.axiom.co/api/embed/efea76b8d7f37062fcded362417a369dc9a3a401.svg \"Repobeats analytics image\")\n\n
\n\n ## Vendors\n\n Images powered by imgur.com\n\n [![imgur.com][imgur-image]](https://apidocs.imgur.com/)\n\n Structured Content powered by sanity.io\n\n [![sanity.io][sanity-image]](https://www.sanity.io/docs/http-api)\n\n [biketag-logo]: https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/biketag-api-logo.jpg\n [imgur-image]: https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/imgur-logo.png\n [sanity-image]: https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/sanity-logo.png\n
![\"npm](\"https://img.shields.io/npm/v/biketag/latest.svg\")
\n \n \n ![\"Build](\"https://github.com/keneucker/biketag-api/workflows/Tests/badge.svg\"){kind=icon}
\n \n 
\n \n ![\"Sponsors\"](\"https://img.shields.io/github/sponsors/keneucker\")
\n \n \n ![\"Sponsors\"](\"https://badges.gitter.im/gitterHQ/gitter.png\")
\n \n![\"Join](\"https://img.shields.io/badge/Join%20the%20community-on%20GitHub%20Discussions-blue\"){kind=icon}
![\"biketag-api](\"https://raw.githubusercontent.com/keneucker/biketag-website/production/public/img/biketag-api-logo.jpg\"){kind=logo}
\n