prismicio-community / csharp-kit

Development kit for the C# language
11 stars 24 forks source link

.NET development kit for prismic.io

nuget

Build Status

Getting started

Install the kit for your project

This kit can be installed using NuGet prismic package. To install prismic from the Package Manager Console, run the following command : PM> Install-Package prismicio

(Feel free to detail the proper steps for beginners by submitting a pull request.)

Get started with prismic.io

You can find out how to get started with prismic.io on our prismic.io developer's portal.

Get started using the kit

Also on our prismic.io developer's portal, on top of our full documentation, you will:

Migration from the old dotnet-kit

Until November 2014, the dotnet kit was based on F# code. This introduced syntax that can be confusing or unnecessarily complex for C# developers. F# users can stick with the older kit, but C# are strongly encouraged to switch to this kit. See Migration.md document for more informations.

Changelog

ReleaseNodes.md.

Contribute to the kit

Contribution is open to all developer levels, read our "Contribute to the official kits" documentation to learn more.

Install the kit locally

This kit gets installed like any .NET library.

(Feel free to detail the proper steps for beginners by submitting a pull request.)

Test

Please write tests for any bugfix or new feature.

If you find existing code that is not optimally tested and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Documentation

Please document any bugfix or new feature.

If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Licence

This software is licensed under the Apache 2 license, quoted below.

Copyright 2017 Prismic.io (https://prismic.io).

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.