Skip to content

Commit

Permalink
[flutter_appauth] updated readme to add a table of contents (#595)
Browse files Browse the repository at this point in the history
* added table of contents to readme

* updated table of contents and location

* added changelog entry for toc addition
  • Loading branch information
MaikuB authored Feb 9, 2025
1 parent c44ff7d commit 88006ad
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions flutter_appauth/CHANGELOG.md
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
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

0 comments on commit 88006ad

Please sign in to comment.