From 88406487ecd14c7d1bedbe1b648bfcf23a49939f Mon Sep 17 00:00:00 2001
From: vlw <victor@vlw.se>
Date: Sun, 27 Oct 2024 11:52:32 +0000
Subject: [PATCH] doc(feat): add README

---
 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..4c1a0d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# MIME-type parser and abstraction library for PHP
+
+Resolve MIME-types from file extensions and vice versa by passing a URL to an RFC 4288-compatible source to this library.
+
+```php
+use vlw\MimeTypes\MimeTypes;
+
+$mime = new MimeTypes("https://raw.githubusercontent.com/apache/httpd/refs/heads/trunk/docs/conf/mime.types");
+
+// From string
+$mime->get_ext_from_type("image/webp"); // "webp"
+$mime->get_type_from_ext("webp"); // "image/webp"
+
+// From pathname
+$mime->get_ext_from_file("path/to/file.webp") // "webp"
+$mime->get_type_from_file("path/to/file.webp) // "image/webp"
+```
+
+# Installation
+
+```sh
+composer require vlw/mime-types
+```
+
+# Use
+
+```php
+use vlw\MimeTypes\MimeTypes;
+
+$mime = new MimeTypes(string $url);
+```
+
+Defaults to [Apache's `mime.types` file from GitHub](https://raw.githubusercontent.com/apache/httpd/refs/heads/trunk/docs/conf/mime.types) if no value is provided to `$url`
\ No newline at end of file