Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[flutter_appauth] updated readme to add a table of contents #595

Merged
merged 3 commits into from
Feb 9, 2025
Merged

[flutter_appauth] updated readme to add a table of contents #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0177d88
added table of contents to readme
MaikuB Feb 9, 2025
e519fd8
updated table of contents and location
MaikuB Feb 9, 2025
28db1fa
added changelog entry for toc addition
MaikuB Feb 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions flutter_appauth/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
* Migrated Android side of example to use plugin DSL
* Bumped `flutter_lints` dev dependency
* Fixed typo in the code snippet shown in the **End session** section of the readme. Thanks to the PR from [barryguvenkaya](https://github.com/barryguvenkaya)
* Updated readme to add a table of contents

## [8.0.2]

Expand Down
15 changes: 15 additions & 0 deletions flutter_appauth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,21 @@
[![pub package](https://img.shields.io/pub/v/flutter_appauth.svg)](https://pub.dartlang.org/packages/flutter_appauth)
[![Build Status](https://api.cirrus-ci.com/github/MaikuB/flutter_appauth.svg)](https://cirrus-ci.com/github/MaikuB/flutter_appauth/)

- [Introduction](#introduction)
- [Tutorials from identity providers](#tutorials-from-identity-providers)
- [Getting Started](#getting-started)
- [Detecting user cancellation](#detecting-user-cancellation)
- [Refreshing tokens](#refreshing-tokens)
- [End session](#end-session)
- [Handling errors](#handling-errors)
- [Ephemeral Sessions (iOS and macOS only)](#ephemeral-sessions-ios-and-macos-only)
- [Android setup](#android-setup)
- [iOS/macOS setup](#iosmacos-setup)
- [API docs](#api-docs)
- [FAQs](#faqs)


## Introduction
A Flutter bridge for AppAuth (https://appauth.io) used authenticating and authorizing users. Note that AppAuth also supports the PKCE extension that is required some providers so this plugin should work with them.

**IMPORTANT NOTES**:
Expand Down