Skip to content

Commit 48b11f6

Browse files
committed
Update readme to release 1.0.0
1 parent 281402c commit 48b11f6

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Source Link (preview[\*](#preview-status))
1+
# Source Link
22

33
Source Link is a language- and source-control agnostic system for providing first-class source debugging experiences for binaries. The goal of the project is to enable anyone building [NuGet libraries to provide source debugging](https://github.com/dotnet/designs/blob/master/accepted/diagnostics/debugging-with-symbols-and-sources.md) for their users with almost no effort. Microsoft libraries, such as .NET Core and Roslyn have enabled Source Link. Source Link is supported by Microsoft.
44

@@ -10,10 +10,6 @@ The [original Source Link implementation](https://github.com/ctaggart/SourceLink
1010

1111
> If you arrived here from the original Source Link documentation - you do not need to use `SourceLink.Create.CommandLine`. You only need to install the packages listed below.
1212
13-
#### Preview Status
14-
15-
We recommend using Source Link preview for building production packages. Although the implementation details and the public APIs of the Source Link pre-release packages are still in flux, there will be no difference in the format of the data it generates between preview and 1.0.0. The only changes in the generated data we expect are due to bug fixes that target scenario that previously did not work correctly.
16-
1713
## <a name="using-sourcelink">Using Source Link in .NET projects
1814

1915
You can enable Source Link experience in your own .NET project by setting a few properties and adding a PackageReference to a Source Link package:
@@ -52,7 +48,7 @@ For projects hosted by [GitHub](http://github.com) or [GitHub Enterprise](https:
5248

5349
```xml
5450
<ItemGroup>
55-
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0-beta2-19554-01" PrivateAssets="All"/>
51+
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All"/>
5652
</ItemGroup>
5753
```
5854

@@ -62,7 +58,7 @@ For projects hosted by [Azure Repos](https://azure.microsoft.com/en-us/services/
6258

6359
```xml
6460
<ItemGroup>
65-
<PackageReference Include="Microsoft.SourceLink.AzureRepos.Git" Version="1.0.0-beta2-19554-01" PrivateAssets="All"/>
61+
<PackageReference Include="Microsoft.SourceLink.AzureRepos.Git" Version="1.0.0" PrivateAssets="All"/>
6662
</ItemGroup>
6763
```
6864

@@ -73,7 +69,7 @@ For projects hosted by on-prem [Azure DevOps Server](https://azure.microsoft.com
7369

7470
```xml
7571
<ItemGroup>
76-
<PackageReference Include="Microsoft.SourceLink.AzureDevOpsServer.Git" Version="1.0.0-beta2-19554-01" PrivateAssets="All"/>
72+
<PackageReference Include="Microsoft.SourceLink.AzureDevOpsServer.Git" Version="1.0.0" PrivateAssets="All"/>
7773
</ItemGroup>
7874
```
7975

@@ -93,7 +89,7 @@ For projects hosted by [GitLab](https://gitlab.com) reference [Microsoft.SourceL
9389

9490
```xml
9591
<ItemGroup>
96-
<PackageReference Include="Microsoft.SourceLink.GitLab" Version="1.0.0-beta2-19554-01" PrivateAssets="All"/>
92+
<PackageReference Include="Microsoft.SourceLink.GitLab" Version="1.0.0" PrivateAssets="All"/>
9793
</ItemGroup>
9894
```
9995

@@ -103,7 +99,7 @@ For projects in git repositories hosted on [Bitbucket.org](https://bitbucket.org
10399

104100
```xml
105101
<ItemGroup>
106-
<PackageReference Include="Microsoft.SourceLink.Bitbucket.Git" Version="1.0.0-beta2-19554-01" PrivateAssets="All"/>
102+
<PackageReference Include="Microsoft.SourceLink.Bitbucket.Git" Version="1.0.0" PrivateAssets="All"/>
107103
</ItemGroup>
108104
```
109105

@@ -130,9 +126,9 @@ To add Source Link support to your native project add package references corresp
130126

131127
```xml
132128
<packages>
133-
<package id="Microsoft.Build.Tasks.Git" version="1.0.0-beta2-19554-01" targetFramework="native" developmentDependency="true" />
134-
<package id="Microsoft.SourceLink.Common" version="1.0.0-beta2-19554-01" targetFramework="native" developmentDependency="true" />
135-
<package id="Microsoft.SourceLink.GitHub" version="1.0.0-beta2-19554-01" targetFramework="native" developmentDependency="true" />
129+
<package id="Microsoft.Build.Tasks.Git" version="1.0.0" targetFramework="native" developmentDependency="true" />
130+
<package id="Microsoft.SourceLink.Common" version="1.0.0" targetFramework="native" developmentDependency="true" />
131+
<package id="Microsoft.SourceLink.GitHub" version="1.0.0" targetFramework="native" developmentDependency="true" />
136132
</packages>
137133
```
138134

0 commit comments

Comments
 (0)