aboutsummaryrefslogtreecommitdiffstats
path: root/src/ngCookies/cookies.js
diff options
context:
space:
mode:
authorRob Dodson2013-08-15 09:58:50 -0700
committerIgor Minar2013-08-15 10:24:27 -0700
commit380854fd2ce4541aec7970066a0e93ccfb5943cb (patch)
tree423147e098a6cd1abe65f7ca8f121b8291078d82 /src/ngCookies/cookies.js
parent680b8174ac7bcb0fa3c6587dff3b03d92d6b156f (diff)
downloadangular.js-380854fd2ce4541aec7970066a0e93ccfb5943cb.tar.bz2
docs($cookies): add info about angular-cookies.js
per the [top comment here](http://docs.angularjs.org/api/ngCookies.$cookies#comment-912064775) updating documentation so it matches [$resource](http://docs.angularjs.org/api/ngResource.$resource) and instructs the user to include the `angular-cookies.js` and load `ngCookies`. Closes #3607
Diffstat (limited to 'src/ngCookies/cookies.js')
-rw-r--r--src/ngCookies/cookies.js11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/ngCookies/cookies.js b/src/ngCookies/cookies.js
index 68355707..7309b558 100644
--- a/src/ngCookies/cookies.js
+++ b/src/ngCookies/cookies.js
@@ -18,6 +18,17 @@ angular.module('ngCookies', ['ng']).
* Only a simple Object is exposed and by adding or removing properties to/from
* this object, new cookies are created/deleted at the end of current $eval.
*
+ * # Installation
+ * To use $cookies make sure you have included the `angular-cookies.js` that comes in Angular
+ * package. You can also find this file on Google CDN, bower as well as at
+ * {@link http://code.angularjs.org/ code.angularjs.org}.
+ *
+ * Finally load the module in your application:
+ *
+ * angular.module('app', ['ngCookies']);
+ *
+ * and you are ready to get started!
+ *
* @example
<doc:example>
<doc:source>