forked from Lierrmm/Node-CallOfDuty
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17 from diegofigs/chore-readme-tree-shaking-tweaks
chore: readme tree shaking tweaks
Showing
2 changed files
with
37 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,36 @@ | ||
[](https://www.npmjs.com/package/call-of-duty-api) | ||
[](https://npmjs.org/package/call-of-duty-api) | ||
[](https://www.github.com/sponsors/lierrmm) | ||
[](https://www.paypal.me/liammm) | ||
|
||
 | ||
|
||
# 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 | ||
 | ||
<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> • </span> | ||
<a href="https://www.npmjs.com/package/@diegofigs/call-of-duty">npm</a> | ||
<span> • </span> | ||
<a href="https://github.com/diegofigs/call-of-duty/issues/new">Issues</a> | ||
<span> • </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/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters