Skip to content

Commit 82ce4a3

Browse files
author
Bart Koelman
committed
Update README.md
Updated instructions for development Updated compatibility version table Switched order of sections, based on chronological needs
1 parent 6ede176 commit 82ce4a3

File tree

1 file changed

+36
-31
lines changed

1 file changed

+36
-31
lines changed

README.md

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ These are some steps you can take to help you understand what this project is an
3434

3535
## Examples
3636

37-
See the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications. There is also a [Todo List App](https://github.com/json-api-dotnet/TodoListExample) that includes a JADNC API and an EmberJs client.
37+
See the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications. There is also a [Todo List App](https://github.com/json-api-dotnet/TodoListExample) that includes a JsonApiDotNetCore API and an EmberJs client.
3838

3939
## Installation and Usage
4040

@@ -82,45 +82,24 @@ public class Startup
8282
}
8383
```
8484

85-
## Development
86-
87-
Restore all NuGet packages with:
88-
89-
```bash
90-
dotnet restore
91-
```
85+
## Compatibility
9286

93-
### Testing
87+
A lot of changes were introduced in v4. The following chart should help you pick the best version, based on your environment.
9488

95-
Running tests locally requires access to a PostgreSQL database. If you have docker installed, this can be propped up via:
89+
| .NET Version | EF Core Version | JsonApiDotNetCore Version |
90+
| ----------------- | --------------- | ------------------------- |
91+
| .NET Core 2.x | 2.x | v3.x |
92+
| .NET Core 3.1 | 3.1, 5 | v4 |
93+
| .NET 5 | 5 | v4 |
9694

97-
```bash
98-
docker run --rm --name jsonapi-dotnet-core-testing -e POSTGRES_DB=JsonApiDotNetCoreExample -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres:12.0
99-
```
100-
101-
And then to run the tests:
102-
103-
```bash
104-
dotnet test
105-
```
10695

10796
## Contributing
10897

10998
Have a question, found a bug or want to submit code changes? See our [contributing guidelines](./.github/CONTRIBUTING.md).
11099

111-
## Compatibility
100+
## Trying out the latest build
112101

113-
A lot of changes were introduced in v4, the following chart should help you with compatibility issues between .NET Core versions.
114-
115-
| .NET Core Version | EF Core Version | JADNC Version |
116-
| ----------------- | --------------- | ------------- |
117-
| 2.x | 2.x | v3.x |
118-
| 3.x | 3.x, 5.x | v4.x |
119-
| 5.x | 5.x | v4.x |
120-
121-
### Trying out the latest build
122-
123-
After each commit, 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:
102+
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:
124103

125104
* In Visual Studio: **Tools**, **NuGet Package Manager**, **Package Manager Settings**, **Package Sources**
126105
* Click **+**
@@ -129,3 +108,29 @@ After each commit, a new prerelease NuGet package is automatically published to
129108
* Open the NuGet package manager console (**Tools**, **NuGet Package Manager**, **Package Manager Console**)
130109
* Select **AppVeyor JADNC** as package source
131110
* Run command: `Install-Package JonApiDotNetCore -pre`
111+
112+
## Development
113+
114+
To build the code from this repository locally, run:
115+
116+
```bash
117+
dotnet build
118+
```
119+
120+
Running tests locally requires access to a PostgreSQL database. If you have docker installed, this can be propped up via:
121+
122+
```bash
123+
run-docker-postgres.ps1
124+
```
125+
126+
And then to run the tests:
127+
128+
```bash
129+
dotnet test
130+
```
131+
132+
Alternatively, to build and validate the code, run all tests, generate code coverage and produce the NuGet package:
133+
134+
```bash
135+
Build.ps1
136+
```

0 commit comments

Comments
 (0)