Skip to content
This repository has been archived by the owner on Feb 11, 2025. It is now read-only.

Expand readme and add to nuget package #559

Merged
merged 2 commits into from
Feb 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
## About IdentityModel

IdentityModel is a .NET standard helper library for claims-based identity, OAuth 2.0 and OpenID Connect.
IdentityModel is a .NET library for claims-based identity, OAuth 2.0 and OpenID Connect.

For project documentation, please visit [readthedocs](https://identitymodel.readthedocs.io).
It provides an object model to interact with the endpoints defined in the various OAuth
and OpenId Connect specifications in the form of:
- types to represent the requests and responses
- extension methods to invoke requests
- constants defined in the specifications, such as standard scope, claim, and parameter names
- other convenience methods for performing common identity related operations

IdentityModel targets [.NET Standard 2.0](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0),
making it suitable for .NET and .NET Framework.

For more documentation, please visit [readthedocs](https://identitymodel.readthedocs.io).

## Related Packages

- Certified OIDC client library for native apps: [IdentityModel.OidcClient](https://www.nuget.org/packages/IdentityModel.OidcClient)
- Id token validator for IdentityModel.OidcClient based on the Microsoft JWT handler: [IdentityModel.OidcClient.IdentityTokenValidator](https://www.nuget.org/packages/IdentityModel.OidcClient.IdentityTokenValidator)
- [DPoP](https://datatracker.ietf.org/doc/html/rfc9449) extensions for IdentityModel.OidcClient: [IdentityModel.OidcClient.DPoP ](https://www.nuget.org/packages/IdentityModel.OidcClient.DPoP)
- Authentication handler for introspection tokens: [IdentityModel.AspNetCore.OAuth2Introspection](https://www.nuget.org/packages/IdentityModel.AspNetCore.OAuth2Introspection)

## Feedback

IdentityModel is released as open source under the
[Apache 2.0 license](https://github.com/identitymodel/identitymodel/blob/main/LICENSE).
Bug reports and contributions are welcome at
[the GitHub repository](https://github.com/identitymodel/identitymodel).
2 changes: 2 additions & 0 deletions src/IdentityModel.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<PackageIcon>icon.jpg</PackageIcon>
<PackageProjectUrl>https://github.com/IdentityModel/IdentityModel</PackageProjectUrl>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
<PackageReadmeFile>README.md</PackageReadmeFile>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>
Expand All @@ -17,6 +18,7 @@

<ItemGroup>
<None Include="../icon.jpg" Pack="true" Visible="false" PackagePath="" />
<None Include="../README.md" Pack="true" PackagePath=""/>
</ItemGroup>

<!--Strong Naming-->
Expand Down
Loading