From 0177d88643af899e1b81b781a6c592741548ec05 Mon Sep 17 00:00:00 2001 From: Michael Bui <25263378+MaikuB@users.noreply.github.com> Date: Sun, 9 Feb 2025 18:03:58 +1100 Subject: [PATCH 1/3] added table of contents to readme --- flutter_appauth/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/flutter_appauth/README.md b/flutter_appauth/README.md index bb16888..dc859c0 100644 --- a/flutter_appauth/README.md +++ b/flutter_appauth/README.md @@ -1,3 +1,17 @@ +- [Flutter AppAuth Plugin](#flutter-appauth-plugin) + - [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) + + # Flutter AppAuth Plugin [![pub package](https://img.shields.io/pub/v/flutter_appauth.svg)](https://pub.dartlang.org/packages/flutter_appauth) From e519fd8660be2a7a8349ee1bf1dfdf45f0f494c8 Mon Sep 17 00:00:00 2001 From: Michael Bui <25263378+MaikuB@users.noreply.github.com> Date: Sun, 9 Feb 2025 18:13:15 +1100 Subject: [PATCH 2/3] updated table of contents and location --- flutter_appauth/README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/flutter_appauth/README.md b/flutter_appauth/README.md index dc859c0..1074552 100644 --- a/flutter_appauth/README.md +++ b/flutter_appauth/README.md @@ -1,22 +1,23 @@ -- [Flutter AppAuth Plugin](#flutter-appauth-plugin) - - [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) - - # Flutter AppAuth Plugin [![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**: From 28db1fa6a582672fe2fcdd36e9996cc6c585781c Mon Sep 17 00:00:00 2001 From: Michael Bui <25263378+MaikuB@users.noreply.github.com> Date: Sun, 9 Feb 2025 18:14:48 +1100 Subject: [PATCH 3/3] added changelog entry for toc addition --- flutter_appauth/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/flutter_appauth/CHANGELOG.md b/flutter_appauth/CHANGELOG.md index d645b53..b143563 100644 --- a/flutter_appauth/CHANGELOG.md +++ b/flutter_appauth/CHANGELOG.md @@ -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]