Skip to content

Commit

Permalink
Target framework parameters in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
danielmarbach committed Jun 26, 2020
1 parent 9b23a6f commit 9f72137
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ dotnet tool uninstall -g PublicApiGenerator.Tool
Generate public API for fluent assertions 5.6.0 for runtime framework `netcoreapp2.1` and `net461`

```
generate-public-api --target-frameworks netcoreapp2.1;net461 --package FluentAssertions --package-version 5.6.0
generate-public-api --target-frameworks "netcoreapp2.1;net461" --package FluentAssertions --package-version 5.6.0
```

Generate public API for fluent assertions 5.* for runtime framework `net47`
Expand Down Expand Up @@ -156,25 +156,25 @@ generate-public-api --target-frameworks net47 --package FluentAssertions --packa
Generate public API for NServiceBus 7.1.4 for runtime framework `netcoreapp2.2` and `net452`. Note NServiceBus package doesn't contain NServiceBus.dll and therefore it is required to specify the assembly that contains the public API.

```
generate-public-api --target-frameworks netcoreapp2.2;net452 --package NServiceBus --package-version 7.1.4 --assembly NServiceBus.Core.dll
generate-public-api --target-frameworks "netcoreapp2.2;net452" --package NServiceBus --package-version 7.1.4 --assembly NServiceBus.Core.dll
```

Generate a public API for NServiceBus release available on myget

```
generate-public-api --target-frameworks netcoreapp2.2;net452 --package NServiceBus --package-version 7.1.4 --assembly NServiceBus.Core.dll --package-source https://www.myget.org/F/particular/api/v3/index.json
generate-public-api --target-frameworks "netcoreapp2.2;net452" --package NServiceBus --package-version 7.1.4 --assembly NServiceBus.Core.dll --package-source https://www.myget.org/F/particular/api/v3/index.json
```

### Command line arguments

```
--target-frameworks framework|framework;framework
--target-frameworks framework|"framework;framework"
```

The target framework in which the package will be restored. The target framework is also used as runtime to generate the public API. It is required to specify a valid runtime framework. For example

- `netcoreapp2.2;net452` to build a public API for `netcoreapp2.2` and `net452`
- `netcoreapp2.1;net461` to build a public API for `netcoreapp2.1` and `net461`
- `"netcoreapp2.2;net452"` to build a public API for `netcoreapp2.2` and `net452`
- `"netcoreapp2.1;net461"` to build a public API for `netcoreapp2.1` and `net461`
- `net47` to build a public API for `net47`

It is not possible to use `netstandard2.0` because it is not a valid runtime framework.
Expand Down

0 comments on commit 9f72137

Please sign in to comment.