Skip to content

Commit 16fb8be

Browse files
normjdscpinheiro
authored andcommitted
README cleanup
1 parent 5078177 commit 16fb8be

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
1-
# AWS SDK for .NET [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/aws/aws-sdk-net?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2-
The **AWS SDK for .NET** enables .NET developers to easily work with [Amazon Web Services][aws] and build scalable solutions with Amazon S3, Amazon DynamoDB, Amazon Glacier, and more.
1+
# AWS SDK for .NET
2+
The **AWS SDK for .NET** enables .NET developers to easily work with [Amazon Web Services](https://aws.amazon.com/) and build scalable solutions with Amazon S3, Amazon DynamoDB, Amazon Glacier, and more.
33

4-
* [API Docs][docs-api]
5-
* [AWS .NET Developer Blog][dotnet-blog]
6-
* [SDK Homepage][sdk-website]
4+
* [API Docs](https://docs.aws.amazon.com/sdkfornet/v4/apidocs/)
5+
* [AWS .NET Developer Blog](https://aws.amazon.com/blogs/developer/category/programing-language/dot-net/)
6+
* [SDK Homepage](https://aws.amazon.com/sdk-for-net/)
77
* [SDK Developer Guide](https://docs.aws.amazon.com/sdk-for-net)
8-
* [Forum][sdk-forum]
9-
* [GitHub Issues][sdk-issues]
8+
* [GitHub Issues](https://github.com/aws/aws-sdk-net/issues)
109
* [SDK Samples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3)
1110

1211
## Getting Help
1312

14-
Please use these community resources for getting help. We use the [GitHub issues][sdk-issues] for tracking bugs and feature requests and have limited bandwidth to address them.
13+
Please use these community resources for getting help. We use the [GitHub issues](https://github.com/aws/aws-sdk-net/issues) for tracking bugs and feature requests and have limited bandwidth to address them.
1514
* Ask a question on [StackOverflow](http://stackoverflow.com/) and tag it with aws-sdk-net
16-
* Come join the AWS .NET community chat on [gitter](https://gitter.im/aws/aws-sdk-net)
1715
* Open a support ticket with [AWS Support](https://console.aws.amazon.com/support/home)
18-
* If it turns out that you may have found a bug, please open an [issue][sdk-issues]
16+
* If it turns out that you may have found a bug, please open an [issue](https://github.com/aws/aws-sdk-net/issues)
1917

2018
### Opening Issues
2119

2220
If you encounter a bug with AWS SDK for .NET we would like to hear about it. Search the existing [issues](https://github.com/aws/aws-sdk-net/issues?q=is%3Aissue) and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of AWS SDK .NET and the OS you’re using. Please include a stack trace and reduced repro case when appropriate, too.
2321

24-
The [GitHub issues][sdk-issues] are intended for bug reports and feature requests. For help and questions with using AWS SDK for .NET please make use of the resources listed in the Getting Help section. There are limited resources available for handling issues and by keeping the list of open issues clean we can respond in a timely manner.
22+
The [GitHub issues](https://github.com/aws/aws-sdk-net/issues) are intended for bug reports and feature requests. For help and questions with using AWS SDK for .NET please make use of the resources listed in the Getting Help section. There are limited resources available for handling issues and by keeping the list of open issues clean we can respond in a timely manner.
2523

2624
## SDK Change Log
2725

@@ -36,7 +34,7 @@ For information about maintenance and support for SDK major versions and their u
3634

3735
## Modularization
3836

39-
With version 3 of the AWS SDK for .NET the SDK has been modularized. This means a separate NuGet package is created for each service as well as a core project. To use this branch compile the solution in the **sdk** folder that matches the desired platform and then include the assemblies for the services needed as well as the core assembly.
37+
The AWS SDK for .NET the SDK is modularized. This means a separate NuGet package is created for each service as well as a core project. For example an application using Amazon S3 and Amazon SQS will use the AWSSDK.S3 and AWSSDK.SQS NuGet packages. Those packages will pull in the AWSSDK.Core dependency used by the service packages.
4038

4139
## Versioning
4240

@@ -51,7 +49,9 @@ The SDK assemblies are strongly named which requires consumers of the SDK to rec
5149

5250
### Internal Namespace
5351

54-
Classes and interfaces with `Internal` in the namespace name are logically internal to the SDK but are often marked with a `public` access modifier, generally to allow the service-specific packages to use shared functionality in the Core package. Classes and interfaces in these namespaces are subject to modification or removal outside of versioning scheme described above. If you find yourself relying on `Internal` functionality directly, consider [opening a Feature Request](https://github.com/aws/aws-sdk-net/issues/new/choose) for your use case if one does not already exist.
52+
Classes and interfaces with `Internal` in the namespace name are logically internal to the SDK but are often marked with a `public` access modifier, generally to allow the service-specific packages to use shared functionality in the Core package. The [InternalsVisibleToAttribute](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.internalsvisibletoattribute) attribute is not used for this use case because that requires Core to know all possible services it will be used for at compile time. New service packages will be released needing access to the internal logic of core after a Core version has been released.
53+
54+
Classes and interfaces in these namespaces are subject to modification or removal outside of versioning scheme described above. If you find yourself relying on `Internal` functionality directly, consider [opening a Feature Request](https://github.com/aws/aws-sdk-net/issues/new/choose) for your use case if one does not already exist.
5555

5656
## Code Analyzers
5757

@@ -88,7 +88,7 @@ Add a reference to the NuGet package [AWSSDK.Extensions.CrtIntegration](https://
8888
**Important:** Do not run the integration tests on a production account.
8989

9090
Integration tests can be found in the **AWSSDK.IntegrationTests** project. These test assume that a default profile has been
91-
configured for credentials. For information about setting up a default profile read the [Developer Guide][credentials-management].
91+
configured for credentials. For information about setting up a default profile read the [Developer Guide](https://docs.aws.amazon.com/sdk-for-net/v4/developer-guide/creds-assign.html).
9292

9393
The tests are designed to create and delete the resources needed for testing but it is important to keep your data safe. Do not run
9494
these tests on accounts that contain production data or resources. Since AWS resources are created and deleted during the running

0 commit comments

Comments
 (0)