Skip to content

Commit c4a072b

Browse files
JeremyCaneyJeremyCaney
committed
Provided instructions on downloading **NuGet** packages
Provided examples of including dependencies for the **NuGet** package in the `csproj` file.
1 parent 7ab9497 commit c4a072b

5 files changed

Lines changed: 69 additions & 2 deletions

File tree

‎OnTopic.AspNetCore.Mvc/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The `Ignia.Topics.AspNetCore.Mvc` assembly provides a default implementation for
1212
- [View Locations](#view-locations)
1313
- [Example](#example)
1414
- [Configuration](#configuration)
15+
- [Dependencies](#dependencies)
1516
- [Application](#application)
1617
- [Route Configuration](#route-configuration)
1718
- [Composition Root](#composition-root)
@@ -81,6 +82,19 @@ If no match is found, then the next `Accept` header will be searched. Eventually
8182

8283
## Configuration
8384

85+
### Dependencies
86+
Installation can be performed by providing a `<PackageReference /`> to the `OnTopic.AspNetCore.Mvc` **NuGet** package.
87+
```xml
88+
<Project Sdk="Microsoft.NET.Sdk.Web">
89+
…
90+
<ItemGroup>
91+
<PackageReference Include="OnTopic.AspNetCore.Mvc" Version="4.0.0" />
92+
</ItemGroup>
93+
</Project>
94+
```
95+
96+
> *Note:* This package is currently only available on Ignia's private **NuGet** repository. For access, please contact [Ignia](http://www.ignia.com/).
97+
8498
### Application
8599
In the `Startup` class, OnTopic's ASP.NET Core support can be registered by calling the `AddTopicSupport()` extension method:
86100
```

‎OnTopic.Data.Caching/README.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,21 @@ The `CachedTopicRepository` provides an in-memory wrapper around an `ITopicRepos
44
[![OnTopic.Data.Caching package in Internal feed in Azure Artifacts](https://igniasoftware.feeds.visualstudio.com/_apis/public/Packaging/Feeds/46d5f49c-5e1e-47bb-8b14-43be6c719ba8/Packages/3dfb3a0a-c049-407d-959e-546f714dcd0f/Badge)](https://igniasoftware.visualstudio.com/OnTopic/_packaging?_a=package&feed=46d5f49c-5e1e-47bb-8b14-43be6c719ba8&package=3dfb3a0a-c049-407d-959e-546f714dcd0f&preferRelease=true)
55
[![Build Status](https://igniasoftware.visualstudio.com/OnTopic/_apis/build/status/OnTopic-CI-V3?branchName=master)](https://igniasoftware.visualstudio.com/OnTopic/_build/latest?definitionId=7&branchName=master)
66

7-
## Usage
7+
## Installation
8+
Installation can be performed by providing a `<PackageReference /`> to the `OnTopic.Data.Caching` **NuGet** package.
9+
```xml
10+
<Project Sdk="Microsoft.NET.Sdk.Web">
11+
…
12+
<ItemGroup>
13+
<PackageReference Include="OnTopic.Data.Caching" Version="4.0.0" />
14+
</ItemGroup>
15+
</Project>
816
```
17+
18+
> *Note:* This package is currently only available on Ignia's private **NuGet** repository. For access, please contact [Ignia](http://www.ignia.com/).
19+
20+
## Usage
21+
```c#
922
var sqlTopicRepository = new SqlTopicRepository(connectionString);
1023
var cachedTopicRepository = new CachedTopicRepository(sqlTopicRepository);
1124

‎OnTopic.Data.Sql/README.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,22 @@ The `SqlTopicRepository` provides an implementation of the `ITopicRepository` in
66
[![OnTopic.Data.Sql package in Internal feed in Azure Artifacts](https://igniasoftware.feeds.visualstudio.com/_apis/public/Packaging/Feeds/46d5f49c-5e1e-47bb-8b14-43be6c719ba8/Packages/15c8a666-efa5-4b23-b08b-1de907478d2d/Badge)](https://igniasoftware.visualstudio.com/OnTopic/_packaging?_a=package&feed=46d5f49c-5e1e-47bb-8b14-43be6c719ba8&package=15c8a666-efa5-4b23-b08b-1de907478d2d&preferRelease=true)
77
[![Build Status](https://igniasoftware.visualstudio.com/OnTopic/_apis/build/status/OnTopic-CI-V3?branchName=master)](https://igniasoftware.visualstudio.com/OnTopic/_build/latest?definitionId=7&branchName=master)
88

9-
## Usage
9+
10+
## Installation
11+
Installation can be performed by providing a `<PackageReference /`> to the `OnTopic.Data.Sql` **NuGet** package.
12+
```xml
13+
<Project Sdk="Microsoft.NET.Sdk.Web">
14+
…
15+
<ItemGroup>
16+
<PackageReference Include="OnTopic.Data.Sql" Version="4.0.0" />
17+
</ItemGroup>
18+
</Project>
1019
```
20+
21+
> *Note:* This package is currently only available on Ignia's private **NuGet** repository. For access, please contact [Ignia](http://www.ignia.com/).
22+
23+
## Usage
24+
```c#
1125
var sqlTopicRepository = new SqlTopicRepository(connectionString);
1226
var rootTopic = sqlTopicRepository.Load();
1327
```

‎OnTopic.TestDoubles/README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,16 @@ Provides test doubles for use in testing the **OnTopic Library**.
33

44
[![OnTopic.TestDoubles package in Internal feed in Azure Artifacts](https://igniasoftware.feeds.visualstudio.com/_apis/public/Packaging/Feeds/46d5f49c-5e1e-47bb-8b14-43be6c719ba8/Packages/3a741b7a-7fa1-4bdb-bc55-efbac3f04e6c/Badge)](https://igniasoftware.visualstudio.com/OnTopic/_packaging?_a=package&feed=46d5f49c-5e1e-47bb-8b14-43be6c719ba8&package=3a741b7a-7fa1-4bdb-bc55-efbac3f04e6c&preferRelease=true)
55
[![Build Status](https://igniasoftware.visualstudio.com/OnTopic/_apis/build/status/OnTopic-CI-V3?branchName=master)](https://igniasoftware.visualstudio.com/OnTopic/_build/latest?definitionId=7&branchName=master)
6+
7+
## Installation
8+
Installation can be performed by providing a `<PackageReference /`> to the `OnTopic.TestDoubles` **NuGet** package.
9+
```xml
10+
<Project Sdk="Microsoft.NET.Sdk.Web">
11+
…
12+
<ItemGroup>
13+
<PackageReference Include="OnTopic.TestDoubles" Version="4.0.0" />
14+
</ItemGroup>
15+
</Project>
16+
```
17+
18+
> *Note:* This package is currently only available on Ignia's private **NuGet** repository. For access, please contact [Ignia](http://www.ignia.com/).

‎OnTopic.ViewModels/README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,19 @@ The `Ignia.Topics.ViewModels` assembly includes default implementations of basic
66
[![OnTopic.ViewModels package in Internal feed in Azure Artifacts](https://igniasoftware.feeds.visualstudio.com/_apis/public/Packaging/Feeds/46d5f49c-5e1e-47bb-8b14-43be6c719ba8/Packages/b22ec8a0-3966-4dc8-8bf5-69e6264dabd1/Badge)](https://igniasoftware.visualstudio.com/OnTopic/_packaging?_a=package&feed=46d5f49c-5e1e-47bb-8b14-43be6c719ba8&package=b22ec8a0-3966-4dc8-8bf5-69e6264dabd1&preferRelease=true)
77
[![Build Status](https://igniasoftware.visualstudio.com/OnTopic/_apis/build/status/OnTopic-CI-V3?branchName=master)](https://igniasoftware.visualstudio.com/OnTopic/_build/latest?definitionId=7&branchName=master)
88

9+
## Installation
10+
Installation can be performed by providing a `<PackageReference /`> to the `OnTopic.ViewModels` **NuGet** package.
11+
```xml
12+
<Project Sdk="Microsoft.NET.Sdk.Web">
13+
…
14+
<ItemGroup>
15+
<PackageReference Include="OnTopic.ViewModels" Version="4.0.0" />
16+
</ItemGroup>
17+
</Project>
18+
```
19+
20+
> *Note:* This package is currently only available on Ignia's private **NuGet** repository. For access, please contact [Ignia](http://www.ignia.com/).
21+
922
## Inventory
1023
- [`TopicViewModel`](TopicViewModel.cs)
1124
- [`PageTopicViewModel`](PageTopicViewModel.cs)

0 commit comments

Comments
 (0)