1
0
mirror of https://github.com/lancedikson/bowser synced 2026-03-02 03:40:27 +00:00

Update README. Add gh-pages docs link.

This commit is contained in:
Aaron Melocik
2019-02-13 19:54:35 -08:00
parent a2da1fa5be
commit b576932d0e
8 changed files with 9 additions and 10 deletions

View File

@@ -13,13 +13,12 @@ A browser detector. Because sometimes, there is no other way, and not even good
The library is made to help to detect what browser your user has and gives you a convenient API to filter the users somehow depending on their browsers.
**Changes of version 2.0**
### ⚠️ Version 2.0 breaking changes ⚠️
The version 2.0 has drastically changed API. All available methods can be found in the `docs` folder from now on and on a webpage soon.
Version 2.0 has drastically changed the API. All available methods are on the [docs page](https://lancedikson.github.io/bowser/docs).
_For legacy code, check out the [1.x](https://github.com/lancedikson/bowser/tree/v1.x) branch and install it through `npm install bowser@1.9.4`._
# Use cases
First of all, require the library. This is a UMD Module, so it will work for AMD, TypeScript, ES6, and CommonJS module systems.