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.

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

Updated README.md #1923

Merged
merged 5 commits into from
Nov 7, 2023
Merged

Updated README.md #1923

merged 5 commits into from
Nov 7, 2023

Conversation

negoe
Copy link
Contributor

@negoe negoe commented Oct 16, 2023

📌 What's Changed:

  • Updated the project's structure for improved organization and clarity.
  • Replaced outdated links with current, relevant ones to ensure accurate references.
  • Removed older versions and any mentions of deprecated features to maintain focus on the current state of the project.
  • Streamlined the readme by removing any irrelevant or obsolete information.

🔍 Why:

  • These updates aim to enhance the overall quality and usability of the project's documentation.

Updated Structure.
Updated old links. 
Removed older versions and mentions. 
Removed irrelevant information.
@negoe negoe requested a review from a team as a code owner October 16, 2023 05:12
@negoe negoe requested review from fadidurah and melissaahn October 18, 2023 21:23
README.md Outdated

## Using MSAL

- Before you can get a token from Azure AD v2.0 or Azure AD B2C, you'll need to register an application. To register your app, use [the Azure portal](https://aka.ms/AppRegistrations). For Azure AD B2C, checkout [how to register your app with B2C](https://docs.microsoft.com/azure/active-directory-b2c/active-directory-b2c-app-registration).

### Requirements

- Android API Level 16+
- Android API Level 33+
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the minSdkVersion is still set to 16, but our target sdk version recently updated to 33: https://github.com/AzureAD/microsoft-authentication-library-for-android/blob/dev/gradle/versions.gradle

README.md Outdated
@@ -246,19 +196,10 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
## Android Studio Build Requirement
Please note that this project uses [Lombok](https://projectlombok.org/) internally and while using Android Studio you will need to install [Lobmok Plugin](https://plugins.jetbrains.com/plugin/6317-lombok) to get the project to build successfully within Android Studio.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Please note that this project uses [Lombok](https://projectlombok.org/) internally and while using Android Studio you will need to install [Lobmok Plugin](https://plugins.jetbrains.com/plugin/6317-lombok) to get the project to build successfully within Android Studio.
Please note that this project uses [Lombok](https://projectlombok.org/) internally and while using Android Studio you will need to install [Lombok Plugin](https://plugins.jetbrains.com/plugin/6317-lombok) to get the project to build successfully within Android Studio.

README.md Outdated

Run the [quickstart](https://docs.microsoft.com/azure/active-directory/develop/quickstart-v2-android) to see how our Java sample works, or checkout this [list of all MSAL sample repos](https://github.com/AzureAD/microsoft-authentication-library-for-android/wiki/MSAL-Code-Samples).
ADAL Android was deprecated on June 20223. We do not support ADAL. See the [ADAL to MSAL migration guide for Android](https://docs.microsoft.com/azure/active-directory/develop/migrate-android-adal-msal)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ADAL Android was deprecated on June 20223. We do not support ADAL. See the [ADAL to MSAL migration guide for Android](https://docs.microsoft.com/azure/active-directory/develop/migrate-android-adal-msal)
ADAL Android was deprecated on June 2023. We do not support ADAL. See the [ADAL to MSAL migration guide for Android](https://docs.microsoft.com/azure/active-directory/develop/migrate-android-adal-msal)

@negoe negoe merged commit d7a1f0e into dev Nov 7, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants