|
1 | 1 | # Skyline.DataMiner.Sdk |
2 | 2 |
|
3 | | -## About |
| 3 | +## Overview |
4 | 4 |
|
5 | | -TBD |
| 5 | +The **Skyline.DataMiner.Sdk** is a development kit designed to streamline the creation and management of **DataMiner Installation Packages (.dmapp)**. By integrating this SDK into your build process, you can easily generate installation packages for DataMiner through a simple project build or compile step. Additionally, it provides tools to publish these packages directly to the **DataMiner Catalog**, ensuring a smooth and efficient development pipeline. |
6 | 6 |
|
7 | | -## Projects |
| 7 | +--- |
8 | 8 |
|
9 | | -* For more information about Skyline.DataMiner.Sdk, see [Sdk/README.md](Sdk/README.md). |
| 9 | +## Key Features |
10 | 10 |
|
11 | | -### About DataMiner |
| 11 | +- **Automated Package Creation:** |
| 12 | + Automatically generate DataMiner Installation Packages (.dmapp) with minimal setup through a simple project build or compile using this SDK. |
12 | 13 |
|
13 | | -DataMiner is a transformational platform that provides vendor-independent control and monitoring of devices and services. Out of the box and by design, it addresses key challenges such as security, complexity, multi-cloud, and much more. It has a pronounced open architecture and powerful capabilities enabling users to evolve easily and continuously. |
| 14 | +- **Catalog Integration:** |
| 15 | + Leverage the `Publish` command to upload your installation packages, artifacts, and other related components to the DataMiner Catalog. |
14 | 16 |
|
15 | | -The foundation of DataMiner is its powerful and versatile data acquisition and control layer. With DataMiner, there are no restrictions to what data users can access. Data sources may reside on premises, in the cloud, or in a hybrid setup. |
| 17 | +- **Seamless Integration with Visual Studio:** |
| 18 | + Designed to work in combination with **[Skyline.DataMiner.VisualStudioTemplates](https://www.nuget.org/packages/Skyline.DataMiner.VisualStudioTemplates/)**, providing out-of-the-box templates and configurations to accelerate development. |
16 | 19 |
|
17 | | -A unique catalog of 7000+ connectors already exists. In addition, you can leverage DataMiner Development Packages to build your own connectors (also known as "protocols" or "drivers"). |
| 20 | +--- |
18 | 21 |
|
19 | | -> **Note** |
20 | | -> See also: [About DataMiner](https://aka.dataminer.services/about-dataminer). |
| 22 | +## Getting Started |
21 | 23 |
|
22 | | -### About Skyline Communications |
| 24 | +### 1. Installation |
| 25 | +To use the SDK, add it as a dependency in your project via NuGet: |
23 | 26 |
|
24 | | -At Skyline Communications, we deal with world-class solutions that are deployed by leading companies around the globe. Check out [our proven track record](https://aka.dataminer.services/about-skyline) and see how we make our customers' lives easier by empowering them to take their operations to the next level. |
| 27 | +```bash |
| 28 | +dotnet add package Skyline.DataMiner.Sdk |
| 29 | +``` |
25 | 30 |
|
26 | | -<!-- Uncomment below and add more info to provide more information about how to use this package. --> |
27 | | -<!-- ## Getting Started --> |
| 31 | +Or through the Visual Studio Package Manager: |
| 32 | + |
| 33 | +```bash |
| 34 | +Install-Package Skyline.DataMiner.Sdk |
| 35 | +``` |
| 36 | + |
| 37 | +### 2. Setting Up the Project |
| 38 | +Create your DataMiner project using the **Skyline.DataMiner.VisualStudioTemplates**. These templates provide pre-configured project scaffolding, so you can focus on developing your components instead of worrying about setup. |
| 39 | + |
| 40 | +### 3. Building Your Project |
| 41 | +Simply build or compile the project using any standard build tool (e.g., Visual Studio, MSBuild). The SDK will take care of generating the necessary DataMiner Installation Packages (.dmapp). |
| 42 | + |
| 43 | +### 4. Publishing to the Catalog |
| 44 | +Once your package is ready, use the `Publish` command provided by the SDK to upload the package directly to the DataMiner Catalog. |
| 45 | + |
| 46 | +```bash |
| 47 | +dotnet publish |
| 48 | +``` |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +## Example Workflow |
| 53 | + |
| 54 | +1. **Create a new DataMiner solution** using the **Skyline.DataMiner.VisualStudioTemplates**. |
| 55 | +2. **Develop your protocols, automation scripts, or apps** within the provided structure. |
| 56 | +3. **Build the project** to generate the DataMiner Installation Package. |
| 57 | +4. **Publish the package** to the catalog using the `PublishToCatalog` task. |
| 58 | + |
| 59 | +--- |
| 60 | + |
| 61 | +## Licensing |
| 62 | + |
| 63 | +The SDK is licensed under the **Skyline Library License**. |
| 64 | +You may use it for **developing, testing, and validating** DataMiner packages and components. Please refer to the full [LICENSE](../LICENSE.txt) for more details. |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +## About DataMiner |
| 69 | + |
| 70 | +DataMiner is a vendor-independent platform for managing and monitoring devices and services. With support for **7000+ connectors**, you can easily extend its capabilities by creating custom connectors (also known as **protocols** or **drivers**) using this SDK. |
| 71 | +Learn more: [About DataMiner](https://aka.dataminer.services/about-dataminer) |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +## About Skyline Communications |
| 76 | + |
| 77 | +Skyline Communications delivers innovative solutions deployed globally by leading organizations. Our expertise lies in enabling businesses to optimize their operations with ease. |
| 78 | +Check out our [proven track record](https://aka.dataminer.services/about-skyline). |
| 79 | + |
| 80 | +--- |
| 81 | + |
| 82 | +Start building your next-generation DataMiner components today with the **Skyline.DataMiner.Sdk**! |
0 commit comments