ueberauth / ueberauth_facebook

Facebook OAuth2 Strategy for Überauth.

MIT License

77 stars 64 forks source link

Feature/improved docs #58

Closed nbw closed 3 years ago

nbw commented 3 years ago

Documentation improvements

Add state (and other options)

I've recently been working on an app with Facebook login and having been sifting through their docs. I thought it would be worthwhile to add notes about how to pass state since it took me a while to find it in Facebook's docs.

Mention Call options in the README docs
Give an example of passing state

Screenshot 2021-04-12 at 22 54 31

Screenshot 2021-04-12 at 22 27 19

3. Updated Ex Doc

An error would occur when updating the docs. Updating Ex Doc was required to fix it.

Screenshot 2021-04-12 at 22 24 45

4. Linting and formatting

Linter removed a few extra spaces in the README
Ran mix format on mix.exs

doomspork commented 3 years ago

Thank you @nbw! This is great. We're currently working on a Ueberauth PR for state support so I'd like to give those involved in that an opportunity to comment here if need be.

Other PR: https://github.com/ueberauth/ueberauth/pull/136

Hanspagh commented 3 years ago

This looks good indeed, but we might need to wait for #136 to finish

nbw commented 3 years ago

I was just looking back at this PR to remind myself how passing state works again and it seems this might be mergeable now.

Hanspagh commented 3 years ago

@nbw Would mind to fix the conflict, then we can merge :D

nbw commented 3 years ago

@Hanspagh I merged master, but to resolve the lock file I regenerated it. I've noticed that it's updated a number of dependancies. If this is an issue and you'd prefer the mix.lock from master instead then let me know.

Hanspagh commented 3 years ago

I just made sure to undo all the changes to mix.lock since we already ex_doc at version 24.2.