entity-serves
Version:
Backend for entity.works, a Dead by Daylight wiki.
82 lines (46 loc) • 3.27 kB
Markdown
# EntityServes
<a href="https://raw.githubusercontent.com/jaid/entity-serves/master/license.txt"><img src="https://img.shields.io/github/license/jaid/entity-serves?style=flat-square" alt="License"/></a> <a href="https://github.com/sponsors/jaid"><img src="https://img.shields.io/badge/<3-Sponsor-FF45F1?style=flat-square" alt="Sponsor entity-serves"/></a>
<a href="https://actions-badge.atrox.dev/jaid/entity-serves/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Fentity-serves%2Fbadge" alt="Build status"/></a> <a href="https://github.com/jaid/entity-serves/commits"><img src="https://img.shields.io/github/commits-since/jaid/entity-serves/v3.11.0?style=flat-square&logo=github" alt="Commits since v3.11.0"/></a> <a href="https://github.com/jaid/entity-serves/commits"><img src="https://img.shields.io/github/last-commit/jaid/entity-serves?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/jaid/entity-serves/issues"><img src="https://img.shields.io/github/issues/jaid/entity-serves?style=flat-square&logo=github" alt="Issues"/></a>
<a href="https://npmjs.com/package/entity-serves"><img src="https://img.shields.io/npm/v/entity-serves?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/jaid/entity-serves/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/entity-serves?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/entity-serves"><img src="https://img.shields.io/npm/dm/entity-serves?style=flat-square&logo=npm" alt="Downloads"/></a>
**Backend for entity.works, a Dead by Daylight wiki.**
## Installation
<a href="https://npmjs.com/package/entity-serves"><img src="https://img.shields.io/badge/npm-entity--serves-C23039?style=flat-square&logo=npm" alt="entity-serves on npm"/></a>
```bash
npm install --global entity-serves@^3.11.0
```
<a href="https://yarnpkg.com/package/entity-serves"><img src="https://img.shields.io/badge/Yarn-entity--serves-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="entity-serves on Yarn"/></a>
```bash
yarn global add entity-serves@^3.11.0
```
<a href="https://github.com/jaid/entity-serves/packages"><img src="https://img.shields.io/badge/GitHub Packages-@jaid/entity--serves-24282e?style=flat-square&logo=github" alt="@jaid/entity-serves on GitHub Packages"/></a>
(if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages))
```bash
npm install --global @jaid/entity-serves@^3.11.0
```
## CLI Usage
After installing package `entity-serves` globally, you can use its command line interface.
```bash
entity-serves
```
For usage instructions:
```bash
entity-serves --help
```
## Development
Setting up:
```bash
git clone git@github.com:jaid/entity-serves.git
cd entity-serves
npm install
```
Testing:
```bash
npm run test:dev
```
Testing in production environment:
```bash
npm run test
```
## License
[MIT License](https://raw.githubusercontent.com/jaid/entity-serves/master/license.txt)
Copyright © 2020, Jaid \<jaid.jsx@gmail.com> (https://github.com/jaid)