Add basic documentation

Author: WyriHaximus

.idea/php.xml

@@ -1,2 +1,49 @@
-# filesystem
+# Filesystem
+
 Open Telemetry Auto Instrumentation for ReactPHP's Filesystem component
+
+![Continuous Integration](https://github.com/reactphp-inspector/filesystem/workflows/Continuous%20Integration/badge.svg)
+[![Latest Stable Version](https://poser.pugx.org/react-inspector/filesystem/v/stable.png)](https://packagist.org/packages/react-inspector/filesystem)
+[![Total Downloads](https://poser.pugx.org/react-inspector/filesystem/downloads.png)](https://packagist.org/packages/react-inspector/filesystem/stats)
+[![Type Coverage](https://shepherd.dev/github/reactphp-inspector/filesystem/coverage.svg)](https://shepherd.dev/github/reactphp-inspector/filesystem)
+[![License](https://poser.pugx.org/react-inspector/filesystem/license.png)](https://packagist.org/packages/react-inspector/filesystem)
+
+# Installation
+
+To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.
+
+```
+composer require react-inspector/filesystem
+```
+
+# Todo
+
+- [X] Port initial implementation over from private project
+- [ ] Add Unit tests, look at https://github.com/opentelemetry-php/contrib-auto-reactphp for inspiration
+- [ ] Add spans for everything beyond the current implementation that makes sense
+- [ ] Add metrics
+- [ ] Write or generate documentation about everything that this package collects traces and metrics on
+
+# License
+
+The MIT License (MIT)
+
+Copyright (c) 2025 Cees-Jan Kiewiet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -28,9 +28,6 @@
             "ReactInspector\\Tests\\Filesystem\\": "tests"
         }
     },
-    "bin": [
-        "bin/mammatus"
-    ],
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true,