Merge pull request #2 from dmt-software/2.0

2.0

.gitignore

@@ -1,8 +1,5 @@
 .idea
 .phpunit.result.cache
+composer.lock
 composer.phar
-/vendor/
-
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+/vendor

LICENSE → LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 dmt-software
+Copyright (c) 2023 dmt-software
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,29 @@
-# anti-xss-middleware
-anti-xss middleware
+# Anti XSS Middleware
+
+This middleware implements the PSR-15 MiddlewareInterface and can be helpful to prevent XSS attacks. 
+
+## Installation
+
+```bash
+composer install dmt-software/anti-xss-middleware
+```
+
+## Usage
+
+```php
+use DMT\Http\AntiXss\Middleware\AntiXssMiddleware;
+use Psr\Http\Message\ResponseFactoryInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+
+/** @var ResponseFactoryInterface $responseFactory */
+$antiXssMiddleware = new AntiXssMiddleware($responseFactory);
+
+/** @var ServerRequestInterface $request */
+/** @var RequestHandlerInterface $handler */
+$response = $antiXssMiddleware->process($request, $handler);
+
+if ($response->getStatusCode() === 400) {
+    // cross site scripting detected
+}
+```

composer.json

@@ -1,30 +1,32 @@
 {
   "name": "dmt-software/anti-xss-middleware",
-  "description": "anti-xss middleware",
+  "description": "PSR-15 middleware to help prevent xss attacks",
   "minimum-stability": "stable",
-  "license": "mit",
+  "license": "MIT",
   "authors": [
     {
       "name": "lingo",
       "email": "lingo@de-mes.nl"
+    },
+    {
+      "name": "Bas de Mes",
+      "email": "bas@dmt-software.nl"
     }
   ],
   "autoload": {
     "psr-4": {
-      "DMT\\Http\\AntiXss\\Middleware\\": "src"
+      "DMT\\Http\\AntiXss\\Middleware\\": "src/"
     }
   },
   "autoload-dev": {
     "psr-4": {
-      "DMT\\Http\\AntiXss\\Middleware\\": "test"
+      "DMT\\Test\\Http\\AntiXss\\Middleware\\": "test/"
     }
   },
   "require": {
     "psr/http-server-middleware": "^1.0",
     "psr/http-factory": "^1.0",
     "psr/http-message": "^1.0",
-    "pavelsterba/http-exceptions": "^1.1",
-
     "voku/anti-xss": "^4.1"
   },
   "require-dev": {