Improved documentation

avkhozov · Jan 22, 2016 · 7a9a3e5 · 7a9a3e5
1 parent a9df350
commit 7a9a3e5
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,7 @@
 Revision history for Perl extension Mojolicious-Plugin-Model
 
 {{$NEXT}}
+    - Improved documentation.
 
 0.07 2016-01-20T08:57:01Z
     - Added perl version to requirements.

diff --git a/README.md b/README.md
@@ -125,9 +125,10 @@ Parameters to be passed to the class constructor of the model.
 
 ## model
 
-    my $model = $c->model('users');
+    my $model = $c->model($name);
 
-Create and cache a model object with given name.
+Load, create and cache a model object with given name. Default class for
+model `camelize($moniker)::Model`. Return `undef` if model not found.
 
 # METHODS
 

diff --git a/lib/Mojolicious/Plugin/Model.pm b/lib/Mojolicious/Plugin/Model.pm
@@ -185,9 +185,10 @@ L<Mojolicious::Plugin::Model> implements the following helpers.
 
 =head2 model
 
-  my $model = $c->model('users');
+  my $model = $c->model($name);
 
-Create and cache a model object with given name.
+Load, create and cache a model object with given name. Default class for
+model C<camelize($moniker)::Model>. Return C<undef> if model not found.
 
 =head1 METHODS