Skip to content

Commit c8d3976

Browse files
committed
Add readme steps
1 parent 2ff50c4 commit c8d3976

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,24 @@ Have a question, found a bug or want to submit code changes? See our [contributi
9595

9696
## Trying out the latest build
9797

98-
After each commit to the master branch, a new prerelease NuGet package is automatically published to AppVeyor at https://ci.appveyor.com/nuget/jsonapidotnetcore. To try it out, follow the next steps:
99-
100-
* In Visual Studio: **Tools**, **NuGet Package Manager**, **Package Manager Settings**, **Package Sources**
101-
* Click **+**
102-
* Name: **AppVeyor JADNC**, Source: **https://ci.appveyor.com/nuget/jsonapidotnetcore**
103-
* Click **Update**, **Ok**
104-
* Open the NuGet package manager console (**Tools**, **NuGet Package Manager**, **Package Manager Console**)
105-
* Select **AppVeyor JADNC** as package source
106-
* Run command: `Install-Package JonApiDotNetCore -pre`
98+
After each commit to the master branch, a new pre-release NuGet package is automatically published to [GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry).
99+
To try it out, follow the steps below:
100+
101+
1. [Create a Personal Access Token (classic)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) with at least `read:packages` scope.
102+
1. Add our package source to your local user-specific `nuget.config` file by running:
103+
```bash
104+
dotnet nuget add source https://nuget.pkg.github.com/json-api-dotnet/index.json --name github-json-api --username YOUR-GITHUB-USERNAME --password YOUR-PAT-CLASSIC
105+
```
106+
In the command above:
107+
- Replace YOUR-GITHUB-USERNAME with the username you use to login your GitHub account.
108+
- Replace YOUR-PAT-CLASSIC with the token your created above.
109+
110+
:warning: If the above command doesn't give you access in the next step, remove the package source by running:
111+
```bash
112+
dotnet nuget remove source github-json-api
113+
```
114+
and retry with the `--store-password-in-clear-text` switch added.
115+
1. Restart your IDE, open your project, and browse the list of packages from the github-json-api feed (make sure pre-release packages are included).
107116

108117
## Development
109118

@@ -125,7 +134,7 @@ And then to run the tests:
125134
dotnet test
126135
```
127136

128-
Alternatively, to build and validate the code, run all tests, generate code coverage and produce the NuGet package:
137+
Alternatively, to build and validate the code style, run all tests, generate code coverage and produce the NuGet package:
129138

130139
```bash
131140
pwsh Build.ps1

0 commit comments

Comments
 (0)