aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2013-04-12 17:31:16 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2013-04-12 17:31:16 +0200
commitc37ee63af3ac291155c43ae348d5ff2ea23af048 (patch)
treed0faeeb387946fa45b2045619568bd35a214ac02 /README.md
parentcc4fa410b7704e02fc73180e9cb5ba5f3f368ab0 (diff)
downloadMime-c37ee63af3ac291155c43ae348d5ff2ea23af048.zip
Mime-c37ee63af3ac291155c43ae348d5ff2ea23af048.tar.gz
Mime-c37ee63af3ac291155c43ae348d5ff2ea23af048.tar.bz2
Add README.md.
Diffstat (limited to 'README.md')
-rw-r--r--README.md80
1 files changed, 80 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8f80d39
--- /dev/null
+++ b/README.md
@@ -0,0 +1,80 @@
+![Hoa](http://static.hoa-project.net/Image/Hoa_small.png)
+
+Hoa is a **modular**, **extensible** and **structured** set of PHP libraries.
+Moreover, Hoa aims at being a bridge between industrial and research worlds.
+
+# Hoa\Mime
+
+This library allows to manipulate a MIME types database and get some related
+informations about streams.
+
+## Quick usage
+
+As a quick overview, we will see how to get general and stream-related
+informations.
+
+### General informations
+
+All we need is static methods `Hoa\Mime::getExtensionsFromMime` to get
+extensions from a type and `Hoa\Mime::getMimeFromExtension` to get type from an
+extension:
+
+ print_r(Hoa\Mime::getExtensionsFromMime('text/html'));
+
+ /**
+ * Will output:
+ * Array
+ * (
+ * [0] => html
+ * [1] => htm
+ * )
+ */
+
+ var_dump(Hoa\Mime::getMimeFromExtension('webm'));
+
+ /**
+ * Will output:
+ * string(10) "video/webm"
+ */
+
+By default, `Hoa\Mime` uses the `hoa://Library/Mime/Mime.types` file as
+database. We can change this behavior by calling the `Hoa\Mime::compute` before
+any computations:
+
+ Hoa\Mime::compute('/etc/mime.types');
+
+### Stream-related informations
+
+By instanciating the `Hoa\Mime` class with a stream, we are able to get some
+informations about the stream, such as its extension, others extensions, type,
+etc. Thus:
+
+ $type = new Hoa\Mime(new Hoa\File\Read('index.html'));
+
+ var_dump(
+ $type->getExtension(),
+ $type->getOtherExtensions(),
+ $type->getMime(),
+ $type->isExperimental()
+ );
+
+ /**
+ * Will output:
+ * string(4) "html"
+ * array(1) {
+ * [0]=>
+ * string(3) "htm"
+ * }
+ * string(9) "text/html"
+ * bool(false)
+ */
+
+## Documentation
+
+Different documentations can be found on the website:
+[http://hoa-project.net/](http://hoa-project.net/).
+
+## License
+
+Hoa is under the New BSD License (BSD-3-Clause). Please, see
+[`LICENSE`](http://hoa-project.net/LICENSE).