Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.98 KB

README.md

File metadata and controls

72 lines (49 loc) · 2.98 KB

Documentation | Changelog | Roadmap

Dime.Scheduler SDK for .NET

This repository contains the .NET SDK for Dime.Scheduler's. The SDK is a gateway to connect any system to Dime.Scheduler through its extensive import pipeline and large collection of web APIs.

Installation

Use the package manager NuGet to install the SDK:

dotnet add package Dime.Scheduler

Important

Version 2 and onwards is only forwards compatible with Dime.Scheduler cloud. The Dime.Scheduler.Sdk package is maintained for the on-premises version.

Prerequisites

To clone and run this application, you'll need Visual Studio 2022 or higher. It is built on the latest versions of .NET and C#.

Usage

The DimeSchedulerClient class is the entry point and it is where all endpoints are exposed:

DimeSchedulerClient client = new("key");

Tip

An optional argument is available to use the sandbox environment.

Instantiate the object of choice and run it by its corresponding endpoint in the SDK.

Category category = new("Category #1", "#6e62b5");
await client.Categories.CreateAsync(category);

Read more

Check out the 📚 docs » for more info.

Contributing

We welcome contributions. Please check out the contribution and code of conduct guidelines first.

To contribute:

  1. Fork the project
  2. Create a feature branch (git checkout -b feature/mynewfeature)
  3. Commit your changes (git commit -m 'Add mynewfeature')
  4. Push to the branch (git push origin feature/mynewfeature)
  5. Open a pull request