From 1babffe4082c76ed414d5ada7b2c41b3e074d15a Mon Sep 17 00:00:00 2001 From: Michael Jackson Date: Wed, 10 Jun 2020 16:02:46 -0700 Subject: [PATCH] Update API docs --- docs/api-reference.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/api-reference.md b/docs/api-reference.md index d406212c9..ec7c89c6e 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -6,15 +6,17 @@ This is the API reference for [the history JavaScript library](https://github.co The [source code](https://github.com/ReactTraining/history/tree/dev/packages/history) for this library is written in TypeScript, but it is compiled to JavaScript before publishing. Some of the function signatures in this reference include their TypeScript type annotations, but you can always refer to the original source as well. - + -## Overview +## Setup This library includes three `history` object initializers for the different modes we support. They are: -- [Browser history](#browserhistory) -- [Hash history](#hashhistory) -- [Memory history](#memoryhistory) +- [Browser history](#browserhistory) - for building web apps +- [Hash history](#hashhistory) - for building web apps where you don't want to/can't send the URL to the server for some reason +- [Memory history](#memoryhistory) - for building native apps and testing + +An app should only ever need to use one of these modes.