Skip to content

Commit

Permalink
Adding Readme.md for DirectoryServices.Protocols and Regex libraries (#…
Browse files Browse the repository at this point in the history
…77418)

* Adding Readme.md for DirectoryServices.Protocols and Regex libraries

* Apply suggestions from code review

Co-authored-by: Stephen Toub <[email protected]>

* Update README.md

* Apply suggestions from code review

Co-authored-by: Buyaa Namnan <[email protected]>

* Apply suggestion

Co-authored-by: Stephen Toub <[email protected]>
Co-authored-by: Buyaa Namnan <[email protected]>
  • Loading branch information
3 people authored Oct 27, 2022
1 parent 4c11c17 commit 0725430
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/libraries/System.DirectoryServices.Protocols/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# System.DirectoryServices.Protocols
This assembly contains types that provide a managed implementation of the Lightweight Directory Access Protocol (LDAP) version 3 and Directory Services Markup Language (DSML) version 2.0 (V2) standards. The main type used for interacting with an LDAP server is [LdapConnection](https://learn.microsoft.com/dotnet/api/system.directoryservices.protocols.ldapconnection) which uses some system native libraries to create a TCP/IP or UDP LDAP connection to a server, and is able to perform different types of requests to communicate to it. This assembly is supported both in Windows and Unix environments.

Documentation can be found at https://learn.microsoft.com/dotnet/api/system.directoryservices.protocols.

## Contribution Bar
- [x] [We consider new features, new APIs and performance changes](../../libraries/README.md#primary-bar)
- [x] [We consider PRs that target this library for new source code analyzers](../../libraries/README.md#secondary-bars)

This assembly's API hasn't really changed much in the past years, and most of the investment have been towards adding Unix support since prior to .NET 5, this assembly was only supported in Windows. We still haven't achieved feature parity between Windows and Unix, so most of the investment will continue to be making sure that things that are supported in Windows would also work in Unix. Also, this assembly's API design was done prior to the existance of `async/await` model, and given it is heavily reliant on network communication, feature requests to modernize the API could also be considered.

See the [Help Wanted](https://github.com/dotnet/runtime/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+label%3Aarea-System.DirectoryServices) issues.

## Deployment
[System.DirectoryServices.Protocols](https://www.nuget.org/packages/System.DirectoryServices.Protocols) is a NuGet package that get's shipped along with every release of .NET.
19 changes: 19 additions & 0 deletions src/libraries/System.Text.RegularExpressions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# System.Text.RegularExpressions
This assembly provides regular expression functionality. The main type contained in the assembly is [Regex](https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex) class, which represents an immutable regular expression object which can be used to test for matches on given input strings or spans.

Documentation can be found at https://learn.microsoft.com/dotnet/api/system.text.regularexpressions.

## Contribution Bar
- [x] [We consider new features, new APIs and performance changes](../../libraries/README.md#primary-bar)
- [x] [We consider PRs that target this library for new source code analyzers](../../libraries/README.md#secondary-bars)

Recent improvements to the library are detailed at:
- [Regex Performance Improvements in .NET 5](https://devblogs.microsoft.com/dotnet/regex-performance-improvements-in-net-5/)
- [Regular Expression Improvements in .NET 7](https://devblogs.microsoft.com/dotnet/regular-expression-improvements-in-dotnet-7/)

We plan on continuing to focus on performance as well as to add new APIs and features to the engines.

See the [Help Wanted](https://github.com/dotnet/runtime/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+label%3Aarea-System.Text.RegularExpressions) issues.

## Deployment
System.Text.RegularExpressions assembly is part of the shared framework, and ships with every new release of .NET.

0 comments on commit 0725430

Please sign in to comment.