Skip to content
Browse files

Add short doc on loading new types to README

  • Loading branch information...
1 parent 2168c93 commit 86ecc9dc62cd6e528e4ab66664269687ef34f30f Magnus Klaar committed
Showing with 41 additions and 1 deletion.
  1. +41 −1 README.md
View
42 README.md
@@ -26,4 +26,44 @@ ok
<<"application/javascript">>
7> mimetypes:extensions("application/mathematica").
[<<"ma">>,<<"nb">>,<<"mb">>]
-```
+```
+
+Additional types
+----------------
+
+Additional mappings can be loaded at runtime using the ```mimetypes:load/2```
+function. If this function is timing out it is possible to increase the
+timeout using ```mimetypes:load/3```.
+
+``` erlang
+1> application:start(mimetypes).
+ok
+2> mimetypes:load(default, [{<<"ext">>, <<"new/type">>}]).
+ok
+3> mimetypes:extension(<<"ext">>).
+[<<"application/vnd.novadigm.ext">>,<<"new/type">>]
+2> mimetypes:load(default, [{<<"ext">>, <<"new/type">>}], 10000).
+ok
+```
+
+Additional mappings can also be specified using the application environment
+variables for the ```mimetypes``` application. These can be added to the
+config file specified using the ```erl -config``` flag.
+
+``` erlang
+[{mimetypes, [
+ %% Wait for all additional types to be loaded before returning from
+ %% application:start(mimetypes). Set to false to return immidiately
+ %% and load them in the background.
+ {load_async, true},
+ %% Timeout to use for calls to mimetypes:load/3 while loading additional
+ %% mimetypes. The default is the same as for mimetypes:load/2. You may
+ %% need to increase this value.
+ {load_timeout, 5000},
+ {load, [
+ {default, [
+ {<<"ext">>, <<"new/type">>}
+ ]}
+ ]}
+]}].
+```

0 comments on commit 86ecc9d

Please sign in to comment.
Something went wrong with that request. Please try again.