Skip to content

Commit

Permalink
Update template install instructions (#331)
Browse files Browse the repository at this point in the history
  • Loading branch information
wazzamatazz authored May 30, 2023
1 parent 1afaf74 commit 5ad2b0c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/writing-an-adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ An adapter is a component that exposes real-time process data and/or alarm & eve

You can find a tutorial for writing a simple MQTT adapter [here](./tutorials/mqtt-adapter).

All adapters implement the [IAdapter](../src/DataCore.Adapter.Abstractions/IAdapter.cs) interface. Each adapter implements a set of *features*, which are exposed via an [IAdapterFeaturesCollection](../src/DataCore.Adapter.Abstractions/IAdapterFeaturesCollection.cs). Individual features are defined as interfaces, and inherit from [IAdapterFeature](/src/DataCore.Adapter.Abstractions/IAdapterFeature.cs).
All adapters implement the [IAdapter](../src/DataCore.Adapter.Abstractions/IAdapter.cs) interface. Each adapter implements a set of *features*, which are exposed via an [IAdapterFeaturesCollection](../src/DataCore.Adapter.Abstractions/IAdapterFeaturesCollection.cs). Individual features are defined as interfaces, and inherit from [IAdapterFeature](../src/DataCore.Adapter.Abstractions/IAdapterFeature.cs).

> Note that adapters do not have to directly implement the feature interfaces themselves. Instead, the adapter can delegate the feature implementation to a helper class. This is described in more detail [below](#delegating-feature-implementations-to-external-providers).
Expand Down
8 changes: 4 additions & 4 deletions src/DataCore.Adapter.Templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@ You can install the [App Store Connect adapter templates](https://www.nuget.org/
**Latest Version:**

```
dotnet new --install IntelligentPlant.AppStoreConnect.Adapter.Templates
dotnet new install IntelligentPlant.AppStoreConnect.Adapter.Templates
```

> To install a pre-release version, follow the *Specific Version* instructions below.
**Specific Version:**

```
dotnet new --install IntelligentPlant.AppStoreConnect.Adapter.Templates::1.2.3
dotnet new install IntelligentPlant.AppStoreConnect.Adapter.Templates::1.2.3
```

**From Source:**

Alternatively, you can install the template from source by checking out this repository, [building the solution](/build.cake), navigating to the [root templates folder](/src/DataCore.Adapter.Templates) from the command line, and running the following command:
Alternatively, you can install the template from source by checking out this repository, [building the solution](../../build.cake), navigating to the [root templates folder](./) from the command line, and running the following command:

```
dotnet new --install .\
dotnet new install .\
```

# Creating an Adapter and Host using Visual Studio
Expand Down

0 comments on commit 5ad2b0c

Please sign in to comment.