add readme.md

This commit is contained in:
b1ek 2023-03-18 21:37:06 +10:00
parent 4e0f0f3f7e
commit 6bb2549cfb
Signed by: blek
GPG Key ID: 14546221E3595D0C
1 changed files with 33 additions and 0 deletions

33
README.md Normal file
View File

@ -0,0 +1,33 @@
<h1 align='center'>express-browser</h1>
This middleware helps you to easily detect the user's browser.
It uses [which-browser](https://www.npmjs.com/package/which-browser) under the hood, and all the documentation is there
# Installation
```
yarn add --save express-browser
```
Or if you prefer `npm`
```
npm install --save express-browser
```
# Example
```
const express = require('express');
const app = express();
const port = 3000;
const ex_browser = require('express-browser');
app.use(ex_browser);
app.get('/', (req, res) => {
res.send('Your browser is: ' + req.browser.browser.toString());
})
app.listen(port, () => {
console.log(`Example app listening on port ${port}`);
})
```