Skip to content

Commit a86f97c

Browse files
committed
docs: update readme
1 parent 22faf9e commit a86f97c

File tree

1 file changed

+12
-24
lines changed

1 file changed

+12
-24
lines changed

README.md

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
![PepperDash Essentials Pluign Logo](/images/essentials-plugin-blue.png)
22

3-
# Essentials Plugin Template (c) 2023
3+
# Essentials Plugin Template (c) 2025
44

55
## License
66

77
Provided under MIT license
88

99
## Overview
1010

11-
Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://github.com/PepperDash/Essentials/wiki/Plugins) article.
11+
Fork this repo when creating a new plugin for Essentials. For more information about plugins, refer to the Essentials Wiki [Plugins](https://pepperdash.github.io/Essentials/docs/Plugins.html) article.
1212

1313
This repo contains example classes for the three main categories of devices:
14-
* `EssentialsPluginTemplateDevice`: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etc
15-
* `EssentialsPluginTemplateLogicDevice`: Used for devices that contain logic, but don't require any communication with third parties outside the program
16-
* `EssentialsPluginTemplateCrestronDevice`: Used for devices that represent a piece of Crestron hardware
14+
* `MakeModelDevice`: Used for most third party devices which require communication over a streaming mechanism such as a Com port, TCP/SSh/UDP socket, CEC, etc
15+
* `MakeModelLogicDevice`: Used for devices that contain logic, but don't require any communication with third parties outside the program
16+
* `MakeModelCrestronDevice`: Used for devices that represent a piece of Crestron hardware
1717

18-
There are matching factory classes for each of the three categories of devices. The `EssentialsPluginTemplateConfigObject` should be used as a template and modified for any of the categories of device. Same goes for the `EssentialsPluginTemplateBridgeJoinMap`.
18+
There are matching factory classes for each of the three categories of devices. The `MakeModelConfigObject` should be used as a template and modified for any of the categories of device. Same goes for the `MakeModeleBridgeJoinMap`.
1919

2020
This also illustrates how a plugin can contain multiple devices.
2121

@@ -29,14 +29,7 @@ The [Essentials](https://github.com/PepperDash/Essentials) libraries are require
2929

3030
### Installing Dependencies
3131

32-
To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository:
33-
`nuget install .\packages.config -OutputDirectory .\packages -excludeVersion`.
34-
Alternatively, you can simply run the `GetPackages.bat` file.
35-
To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it.
36-
37-
### Installing Different versions of PepperDash Core
38-
39-
If you need a different version of PepperDash Core, use the command `nuget install .\packages.config -OutputDirectory .\packages -excludeVersion -Version {versionToGet}`. Omitting the `-Version` option will pull the version indicated in the packages.config file.
32+
Dependencies will be automatically installed when
4033

4134
### Instructions for Renaming Solution and Files
4235

@@ -46,15 +39,10 @@ For renaming instructions in particular, see the XML `remarks` tags on class def
4639

4740
## Build Instructions (PepperDash Internal)
4841

49-
## Generating Nuget Package
50-
51-
In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec"
52-
53-
1. Rename the file to match your plugin solution name
54-
2. Edit the file to include your project specifics including
55-
1. <id>PepperDash.Essentials.Plugin.MakeModel</id> Convention is to use the prefix "PepperDash.Essentials.Plugin" and include the MakeModel of the device.
56-
2. <projectUrl>https://github.com/PepperDash/EssentialsPluginTemplate</projectUrl> Change to your url to the project repo
42+
## Generating Nuget Package
5743

58-
There is no longer a requirement to adjust workflow files for nuget generation for private and public repositories. This is now handled automatically in the workflow.
44+
A nuget package is automatically generated when the plugin is build. To modify the name and other details of the package, edit the following properties in the .csproj file:
5945

60-
__If you do not make these changes to the nuspec file, the project will not generate a nuget package__
46+
1. `PackageId` - This is the name that will be used to pull the package from Nuget once it's published
47+
2. `PackgeProjectUrl` - This should match the URL for the plugin repo
48+
3. `AssemblyTitle` - This is the dll file name that is will show on a processor when the plugin is loaded

0 commit comments

Comments
 (0)