Skip to content

Commit 09f380a

Browse files
author
Sankarsan Kampa
committed
Added README
1 parent 23a3a8b commit 09f380a

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Pokédex API <small>Library Wrapper</small>
2+
A wrapper library for the [Pokédex API](https://pokedevs.bastionbot.org).
3+
Get all your Pokémon Needs in one place.
4+
5+
[![GitHub release](https://img.shields.io/github/release/PokeDevs/node-pokedex-api.svg?style=flat)](https://github.com/PokeDevs/node-pokedex-api/releases)
6+
[![Dependencies](https://david-dm.org/PokeDevs/node-pokedex-api.svg)](https://david-dm.org/PokeDevs/node-pokedex-api)
7+
[![license](https://img.shields.io/github/license/PokeDevs/node-pokedex-api.svg)](LICENSE)
8+
9+
## Installation
10+
This is a [Node.js](https://nodejs.org/en) module available through the
11+
[npm registry](https://www.npmjs.com/).
12+
13+
Before installing, [download and install Node.js](https://nodejs.org/en/download/).
14+
We recommend installing the latest LTS version of Node.js.
15+
16+
Installation is done using the [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
17+
18+
```bash
19+
$ npm install pokdex-api --save
20+
```
21+
22+
## Get Started
23+
Read the [Wiki](https://github.com/PokeDevs/node-pokedex-api/wiki) to see the available classes and methods (with examples) and know
24+
how to use them.
25+
26+
## Pokédex API
27+
* [Official Website and Documentation](https://pokedevs.bastionbot.org)
28+
* [GitHub Organization](https://github.com/PokeDevs) for other libraries
29+
* [Discord](https://discord.gg/7P4H3TY) for support and discussion
30+
31+
## Contributors
32+
The developer of the [Pokédex API](https://pokedevs.bastionbot.org) and this
33+
wrapper library is [k3rn31p4nic](https://sankarsankampa.com)
34+
35+
[List of all contributors](https://github.com/PokeDevs/node-pokedex-api/graphs/contributors)
36+
37+
## License
38+
39+
[GPL-3.0](https://github.com/PokeDevs/node-pokedex-api/blob/master/LICENSE)

0 commit comments

Comments
 (0)