Skip to content

Commit

Permalink
Merge pull request #44 from marcelwemhoff/main
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
ckuetbach authored Nov 11, 2024
2 parents 472ec94 + b76784d commit 10f7c31
Showing 1 changed file with 9 additions and 14 deletions.
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,26 @@
# d.velop cloud SDK for .NET core
# d.velop cloud SDK for .NET

This is the official SDK to build Apps for [d.velop cloud](https://www.d-velop.de/cloud/) using
the C# programming language.
This is the official SDK to build Apps for [d.velop cloud](https://www.d-velop.de/cloud/) using the C# programming language.

The project has alpha status. **So for now expect things to change.**



## Usage

Include the the d.velop cloud sdk as dependencies in your .NET Core 2.1 project file (`myproject.csproj`) and restore them with `dotnet restore` via commandline or from within your IDE.
Include the d.velop sdk packages as dependencies in your .NET 8 project file (`myproject.csproj`) and restore them with `dotnet restore` via commandline or from within your IDE.

Example:
```xml
<ItemGroup>
<PackageReference Include="Dvelop.Sdk.TenantMiddleware" Version="0.0.2.51" />
<PackageReference Include="Dvelop.Sdk.IdentityProvider.Middleware" Version="0.0.2.51" />
<PackageReference Include="Dvelop.Sdk.TenantMiddleware" Version="0.1.0.27" />
<PackageReference Include="Dvelop.Sdk.IdentityProvider.Middleware" Version="0.1.0.27" />
</ItemGroup>
```

or the all-in-one dependency:

```xml
<ItemGroup>
<PackageReference Include="Dvelop.Sdk" Version="0.0.2.51" />
<PackageReference Include="Dvelop.Sdk" Version="0.1.0.27" />
</ItemGroup>
```

Expand All @@ -32,8 +30,7 @@ A running Application, which uses this SDK can be found at [github.com/d-velop/d

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct,
and the process for submitting pull requests to us.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Build local

Expand All @@ -43,7 +40,7 @@ You can build a version of this library with following command:
dotnet pack -o dist --version-suffix alpha
```

You will need to have an installed and configured dotnet core SDK
You will need to have an installed and configured dotnet SDK.

## Versioning

Expand All @@ -61,5 +58,3 @@ Thanks to the following projects for inspiration
* [Starting an Open Source Project](https://opensource.guide/starting-a-project/)
* [README template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
* [CONTRIBUTING template](https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-template.md)

[![Build Status](https://travis-ci.com/d-velop/dvelop-sdk-cs.svg?branch=main)](https://travis-ci.com/d-velop/dvelop-sdk-cs)

0 comments on commit 10f7c31

Please sign in to comment.