aboutsummaryrefslogtreecommitdiffstats
path: root/src/ngResource
diff options
context:
space:
mode:
authorCiro Nunes2013-03-05 00:04:18 -0300
committerIgor Minar2013-04-04 08:54:45 -0700
commit0ef9d54ccd3643b95f8ffee6641fb0b552af127f (patch)
treeaeb6a7f44bc274f4a7c3cb4df4257c1477f9b206 /src/ngResource
parent6ade77efa295a276ea2f6c19ab3edef02ecad327 (diff)
downloadangular.js-0ef9d54ccd3643b95f8ffee6641fb0b552af127f.tar.bz2
docs($resource): Added an installation section.
Diffstat (limited to 'src/ngResource')
-rw-r--r--src/ngResource/resource.js9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/ngResource/resource.js b/src/ngResource/resource.js
index a05e3598..6f44a50d 100644
--- a/src/ngResource/resource.js
+++ b/src/ngResource/resource.js
@@ -18,6 +18,15 @@
* The returned resource object has action methods which provide high-level behaviors without
* the need to interact with the low level {@link ng.$http $http} service.
*
+ * # Installation
+ * To use $resource make sure you have included the `angular-resource.js` that comes in Angular
+ * package. You also can find this stuff in {@link http://code.angularjs.org/ code.angularjs.org}.
+ * Finally load the module in your application:
+ *
+ * angular.module('app', ['ngResource']);
+ *
+ * and you ready to get started!
+ *
* @param {string} url A parameterized URL template with parameters prefixed by `:` as in
* `/user/:username`. If you are using a URL with a port number (e.g.
* `http://example.com:8080/api`), you'll need to escape the colon character before the port