README.md in angular_rails_csrf-3.1.0 vs README.md in angular_rails_csrf-3.2.0
- old
+ new
@@ -1,10 +1,9 @@
## AngularJS-style CSRF Protection for Rails
[![Gem Version](https://badge.fury.io/rb/angular_rails_csrf.svg)](https://badge.fury.io/rb/angular_rails_csrf)
[![Build Status](https://travis-ci.org/jsanders/angular_rails_csrf.png)](https://travis-ci.org/jsanders/angular_rails_csrf)
-[![Dependency Status](https://gemnasium.com/badges/github.com/jsanders/angular_rails_csrf.svg)](https://gemnasium.com/github.com/jsanders/angular_rails_csrf)
The AngularJS [ng.$http](http://docs.angularjs.org/api/ng.$http) service has built-in CSRF protection. By default, it looks for a cookie named `XSRF-TOKEN` and, if found, writes its value into an `X-XSRF-TOKEN` header, which the server compares with the CSRF token saved in the user's session.
This project adds direct support for this scheme to your Rails application without requiring any changes to your AngularJS application. It also doesn't require the use of `csrf_meta_tags` to write a CSRF token into your page markup, so it works for pure JSON API applications.
@@ -23,10 +22,23 @@
$ bundle
That's it!
## Configuration
+
+### Cookie Name
+
+The default cookie's name is `XSRF-TOKEN` but it can be configured with the `angular_rails_csrf_cookie_name` setting:
+
+```ruby
+# application.rb
+class Application < Rails::Application
+ #...
+ config.angular_rails_csrf_cookie_name = 'CUSTOM_NAME'
+end
+```
+
### Cookie Domain
Starting from version 3, you may set domain for the XSRF cookie:
```ruby
@@ -65,6 +77,6 @@
$ rake test
```
## License
-Licensed under the [MIT License](https://github.com/jsanders/angular_rails_csrf/blob/master/LICENSE).
\ No newline at end of file
+Licensed under the [MIT License](https://github.com/jsanders/angular_rails_csrf/blob/master/LICENSE).