From 6bb2549cfb826f23e2107814aaaf7a9077379ad3 Mon Sep 17 00:00:00 2001
From: b1ek <me@blek.codes>
Date: Sat, 18 Mar 2023 21:37:06 +1000
Subject: [PATCH] add readme.md

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f8c2c23
--- /dev/null
+++ b/README.md
@@ -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}`);
+})
+```
\ No newline at end of file