Skip to content
This repository has been archived by the owner on Aug 4, 2024. It is now read-only.

Commit

Permalink
Project deprecation (#320)
Browse files Browse the repository at this point in the history
  • Loading branch information
lwojcik authored Aug 4, 2024
1 parent 7f45b19 commit 6b07c52
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 387 deletions.
5 changes: 0 additions & 5 deletions .github/FUNDING.yml

This file was deleted.

74 changes: 0 additions & 74 deletions .mergify.yml

This file was deleted.

128 changes: 0 additions & 128 deletions CODE_OF_CONDUCT.md

This file was deleted.

101 changes: 0 additions & 101 deletions CONTRIBUTING.md

This file was deleted.

35 changes: 5 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
<img src="https://raw.githubusercontent.com/blizzapi/starcraft2-api-docs/master/docs/.vuepress/public/logo.png" alt="StarCraft2-API logo" width="200" height="200">

# StarCraft2-API

[![npm (latest)](https://img.shields.io/npm/v/starcraft2-api/latest.svg)](https://www.npmjs.com/package/starcraft2-api)
[![Build status](https://ci.appveyor.com/api/projects/status/p4f467gw2ufh1gub/branch/master?svg=true)](https://ci.appveyor.com/project/lwojcik/starcraft2-api/branch/master)
[![codecov](https://codecov.io/gh/blizzapi/starcraft2-api/branch/master/graph/badge.svg?token=L8OOti0dKF)](https://codecov.io/gh/blizzapi/starcraft2-api)
> **This project is no longer maintained or updated. While Battle.net API has been reasonably stable within last few years and that means the library should theoretically continue working for a while, I am no longer able to provide any support or maintenance.** > **In case of bugs or breaking changes, feel free to fork the repo and publish your own updated version.**
Flexible and feature-rich JavaScript / TypeScript library for easy access to [StarCraft II Community APIs](https://develop.battle.net/documentation/starcraft-2/community-apis) and [StarCraft II Game Data APIs](https://develop.battle.net/documentation/starcraft-2/game-data-apis) powered by [BlizzAPI](https://github.com/blizzapi/blizzapi).
Flexible and feature-rich JavaScript / TypeScript library for easy access to StarCraft II Community APIs.

## Install

Expand Down Expand Up @@ -42,36 +38,15 @@ console.log(data);
## Manual build

```bash
git clone https://github.com/blizzapi/starcraft2-api.git
git clone https://github.com/lwojcik/starcraft2-api.git
cd starcraft2-api
npm install
npm run build
```

## Documentation & examples

- [starcraft2-api.lukem.net](https://starcraft2-api.lukem.net) - documentation
- [starcraft2-api-docs](https://github.com/blizzapi/starcraft2-api-docs) - documentation repo on GitHub
- [starcraft2-api-example](https://github.com/blizzapi/starcraft2-api-example) - sample Express.js REST API with usage examples
- [Repositories that depend on StarCraft2-API](https://github.com/blizzapi/starcraft2-api/network/dependents)

## Contributions

Contributions of any kind are welcome.

You can contribute to StarCraft2-API by:

- submiting a bug report or a feature suggestion
- improving documentation either within the project itself or in the [doc site repository](https://github.com/blizzapi/starcraft2-api-docs)
- submitting pull requests

Before contributing be sure to read [Contributing Guidelines](https://github.com/blizzapi/starcraft2-api/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://github.com/blizzapi/starcraft2-api/blob/master/CODE_OF_CONDUCT.md).

## Contributors

To all who contribute code, improve documentation, submit issues or feature requests - thank you for making StarCraft2-API even better!
## Documentation

We maintain an [AUTHORS](https://github.com/blizzapi/starcraft2-api/blob/master/AUTHORS) file where we keep a list of all project contributors. Please consider adding your name there with your next PR.
See [starcraft2-api-docs](https://github.com/lwojcik/starcraft2-api-docs) repo.

## Legal

Expand Down
19 changes: 0 additions & 19 deletions appveyor.yml

This file was deleted.

Loading

0 comments on commit 6b07c52

Please sign in to comment.