Skip to content

Commit 749bea4

Browse files
authored
Minor updates to docs (#1236)
1 parent 237f49d commit 749bea4

3 files changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ Please read the [issue template](https://github.com/lynndylanhurley/devise_token
6565

6666
See our [Contribution Guidelines](https://github.com/lynndylanhurley/devise_token_auth/blob/master/.github/CONTRIBUTING.md). Feel free to submit pull requests, review pull requests, or review open issues. If you'd like to get in contact, [Zach Feldman](https://github.com/zachfeldman) has been wrangling this effort, you can reach him with his name @gmail. Further discussion of this in [this issue](https://github.com/lynndylanhurley/devise_token_auth/issues/969).
6767

68+
We have some bounties for some issues, [check them out](https://github.com/lynndylanhurley/devise_token_auth/issues?q=is%3Aopen+is%3Aissue+label%3Abounty)!
69+
6870
## Live Demos
6971

7072
[Here is a demo](http://ng-token-auth-demo.herokuapp.com/) of this app running with the [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) module and [AngularJS](https://github.com/angular/angular.js).

docs/faq.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## FAQ
22

3+
### I have missing headers or issues with batch requests
4+
5+
Try disabling `change_headers_on_each_request`, it's a nice to have security enhancement but not crucial. If you are curious, you can check how we [manage the tokens and batch requests](docs/conceptual.md)
6+
37
### Can I use this gem alongside standard Devise?
48

59
Yes! But you will need to enable the support of separate routes for standard Devise. So do something like this:

docs/usage/controller_methods.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ This gem provides access to all of the following [devise helpers](https://github
2727
| **`current_user`** | Returns the currently signed-in `User`, or `nil` if unavailable. |
2828
| **`user_signed_in?`** | Returns `true` if a `User` is signed in, otherwise `false`. |
2929
| **`devise_token_auth_group`** | Operate on multiple user classes as a group. [Read more](#group-access) |
30+
| **`update_auth_header`** | After action that updates the header with the new token, it's included by default, you should skip it if you are destroying the user |
3031

3132
Note that if the model that you're trying to access isn't called `User`, the helper method names will change. For example, if the user model is called `Admin`, the methods would look like this:
3233

0 commit comments

Comments
 (0)