Skip to content

Commit 4db92c6

Browse files
committed
Update readme
1 parent 9b0ecee commit 4db92c6

1 file changed

Lines changed: 49 additions & 12 deletions

File tree

README.md

Lines changed: 49 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ A PokeAPI wrapper intended for browsers only. Comes fully asynchronous (with [lo
2828
- [Locations](#locations)
2929
- [Pokemon](#pokemon)
3030
- [Utility](#utility)
31+
- [Custom URLs and paths](#custom-urls-and-paths)
3132
- [Root Endpoints](#root-endpoints)
3233
- [List of supported root endpoints](#list-of-supported-root-endpoints)
3334
- [Internet Explorer 8](#internet-explorer-8)
@@ -144,7 +145,8 @@ This method fetches data asynchronously. So it is quite fast :smile:
144145
// response.forEach((item) => {console.log(item.size)}) // 80,50,20
145146
```
146147

147-
### Contests
148+
<details>
149+
<summary>### Contests</summary>
148150

149151
Use **getContestTypeByName** to return data about the effects of moves when used in contests.
150152

@@ -173,7 +175,10 @@ Use **getSuperContestEffectById** to return data about the effects of moves when
173175
});
174176
```
175177

176-
### Encounters
178+
</details>
179+
180+
<details>
181+
<summary>### Encounters</summary>
177182

178183
Use **getEncounterMethodByName** to return data about the conditions in which a trainer may encounter a pokemon in the wild.
179184

@@ -202,7 +207,10 @@ Use **getEncounterConditionValueByName** to return data the various states that
202207
});
203208
```
204209

205-
### Evolution
210+
</details>
211+
212+
<details>
213+
<summary>### Evolution</summary>
206214

207215
Use **getEvolutionChainById** to return data evolution chains.
208216

@@ -222,7 +230,10 @@ Use **getEvolutionTriggerByName** to return data about triggers which cause poke
222230
});
223231
```
224232

225-
### Games
233+
</details>
234+
235+
<details>
236+
<summary>### Games</summary>
226237

227238
Use **getGenerationByName** to return data about the different generations of pokemon games.
228239

@@ -260,7 +271,10 @@ Use **getVersionGroupByName** to return data about specific version groups of po
260271
});
261272
```
262273

263-
### Items
274+
</details>
275+
276+
<details>
277+
<summary>### Items</summary>
264278

265279
Use **getItemByName** to return data about specific items.
266280

@@ -307,7 +321,10 @@ Use **getItemPocketByName** to return data about specific pockets in a players b
307321
});
308322
```
309323

310-
### Machines
324+
</details>
325+
326+
<details>
327+
<summary>### Machines</summary>
311328

312329
Use **getMachineById** to return data about specific machine.
313330

@@ -318,7 +335,10 @@ Use **getMachineById** to return data about specific machine.
318335
});
319336
```
320337

321-
### Moves
338+
</details>
339+
340+
<details>
341+
<summary>### Moves</summary>
322342

323343
Use **getMoveByName** to return data about specific pokemon move.
324344

@@ -383,7 +403,10 @@ Use **getMoveTargetByName** to return data about specific pokemon move target.
383403
});
384404
```
385405

386-
### Locations
406+
</details>
407+
408+
<details>
409+
<summary>### Locations</summary>
387410

388411
Use **getLocationByName** to return data about specific pokemon location.
389412

@@ -421,7 +444,10 @@ Use **getRegionByName** to return data about specific pokemon region.
421444
});
422445
```
423446

424-
### Pokemon
447+
</details>
448+
449+
<details>
450+
<summary>### Pokemon</summary>
425451

426452
Use **getAbilityByName** to return data about specific pokemon ability.
427453

@@ -558,7 +584,10 @@ Use **getTypeByName** to return data about specific pokemon type.
558584
});
559585
```
560586

561-
### Utility
587+
</details>
588+
589+
<details>
590+
<summary>### Utility</summary>
562591

563592
Use **getLanguageByName** to return data about specific pokemon language.
564593

@@ -569,7 +598,10 @@ Use **getLanguageByName** to return data about specific pokemon language.
569598
});
570599
```
571600

572-
### Custom URLs and paths
601+
</details>
602+
603+
<details>
604+
<summary>### Custom URLs and paths</summary>
573605

574606
Use **resource** to return data about any URL or path.
575607

@@ -585,6 +617,8 @@ Use **resource** to return data about any URL or path.
585617
});
586618
```
587619

620+
</details>
621+
588622
## Root Endpoints
589623

590624
For each root endpoint we provide a method to get all the items contained by that endpoint. By default the method will return every item in the endpoint. If you want you can configure its offset and limit.
@@ -637,7 +671,8 @@ This is what you will get:
637671
}
638672
```
639673

640-
### List of supported root endpoints
674+
<details>
675+
<summary>### List of supported root endpoints</summary>
641676

642677
- .getEndpointsList()
643678
- .getBerriesList()
@@ -689,6 +724,8 @@ This is what you will get:
689724
- .getTypesList()
690725
- .getLanguagesList()
691726

727+
</details>
728+
692729
## Internet Explorer 8
693730

694731
In order to target this browser if must load a Promise polyfill before `pokeapi-js-wrapper`. You can choose one of your chioce, we recommed [jakearchibald/es6-promise](https://cdnjs.com/libraries/es6-promise) or [stefanpenner/es6-promise](https://github.com/stefanpenner/es6-promise)

0 commit comments

Comments
 (0)