Skip to content

Commit

Permalink
Merge pull request #17 from diegofigs/chore-readme-tree-shaking-tweaks
Browse files Browse the repository at this point in the history
chore: readme tree shaking tweaks
diegofigs authored Aug 25, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
2 parents 38e6670 + bc5423b commit e24401d
Showing 2 changed files with 37 additions and 25 deletions.
61 changes: 36 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,36 @@
[![npm version](https://badge.fury.io/js/call-of-duty-api.svg)](https://www.npmjs.com/package/call-of-duty-api)
[![https://npmjs.org/package/call-of-duty-api](https://badgen.net/npm/dt/call-of-duty-api?icon=npm)](https://npmjs.org/package/call-of-duty-api)
[![https://www.github.com/sponsors/lierrmm](https://img.shields.io/badge/github-donate-teal.svg)](https://www.github.com/sponsors/lierrmm)
[![https://www.paypal.me/liammm](https://img.shields.io/badge/paypal-donate-blue.svg)](https://www.paypal.me/liammm)

![https://npmjs.org/package/call-of-duty-api](https://github.com/Lierrmm/Node-CallOfDuty/blob/master/logo.png?raw=true)

# Call Of Duty API Wrapper

Call of Duty Api is a promised based wrapper for the "private" API that Activision use on the callofduty.com website.

This wrapper is written in NodeJS and is publicly available on [npm](https://npmjs.org/package/call-of-duty-api).

# Discord

Join the discord: [here](https://discord.gg/NuUpvzC)

# Website
https://codapi.dev

# Documentation
You can find documentation [here](https://docs.codapi.dev/).

# Stats
![Alt](https://repobeats.axiom.co/api/embed/11dfd4cc8f054e2599ff859fdef15856e5b36ea2.svg "Repobeats Analytics for Node-CallOfDuty")
<p align="center">
<img src="logo.png" width="200px" align="center" alt="Cod logo" />
<h1 align="center">@diegofigs/call-of-duty</h1>
<p align="center">
✨ <a href="https://diegofigs.github.io/call-of-duty/">https://diegofigs.github.io/call-of-duty/</a> ✨
<br/>
TypeScript-first, unit-tested Call of Duty API for Web/Node.js
</p>
</p>
<br/>
<p align="center">
<a href="https://github.com/diegofigs/call-of-duty/actions?query=branch%3Amaster"><img src="https://github.com/diegofigs/call-of-duty/actions/workflows/node.js.yml/badge.svg?branch=main" alt="call-of-duty CI status" /></a>
<a href="https://twitter.com/diegofigs" rel="nofollow"><img src="https://img.shields.io/badge/created%[email protected]" alt="Created by Diego Figueroa"></a>
<a href="https://opensource.org/licenses/MIT" rel="nofollow"><img src="https://img.shields.io/github/license/diegofigs/call-of-duty" alt="License"></a>
<a href="https://www.npmjs.com/package/@diegofigs/call-of-duty" rel="nofollow"><img src="https://badge.fury.io/js/@diegofigs%2Fcall-of-duty.svg" alt="npm"></a>
<a href="https://www.npmjs.com/package/@diegofigs/call-of-duty" rel="nofollow"><img src="https://badgen.net/npm/dt/@diegofigs/call-of-duty?icon=npm" alt="npm"></a>
<a href="https://www.npmjs.com/package/@diegofigs/call-of-duty" rel="nofollow"><img src="https://img.shields.io/github/stars/diegofigs/call-of-duty" alt="stars"></a>
</p>
<div align="center">
<a href="https://diegofigs.github.io/call-of-duty/">Documentation</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://www.npmjs.com/package/@diegofigs/call-of-duty">npm</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://github.com/diegofigs/call-of-duty/issues/new">Issues</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://twitter.com/diegofigs">@diegofigs</a>
<br />
</div>
<br />

## Inspiration
The OG `call-of-duty-api` library is feature-complete but lacks in documentation, development experience in the form of hinting/autocompletion and no web support.
This library aims to fix that by leveraging Typescript, continuous integration with semantic release and bundling for both node/web contexts. Vision is a drop-in replacement to [call-of-duty-api](https://npmjs.org/package/call-of-duty-api).

## Documentation
You can find documentation [here](https://diegofigs.github.io/call-of-duty/).
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -15,6 +15,7 @@
"main": "./dist/index.cjs",
"module": "./dist/index.js",
"unpkg": "./dist/index.umd.js",
"sideEffects": false,
"scripts": {
"prebuild": "rimraf dist",
"build": "microbundle",

0 comments on commit e24401d

Please sign in to comment.