Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prismicio-community/csharp-kit

Development kit for the C# language
https://github.com/prismicio-community/csharp-kit

Last synced: 2 months ago
JSON representation

Development kit for the C# language

Awesome Lists containing this project

README 

        
## .NET development kit for prismic.io



[![nuget](https://img.shields.io/nuget/v/Prismicio.svg)](https://www.nuget.org/packages/prismicio/)



[![Build Status](https://api.travis-ci.org/prismicio/csharp-kit.png)](https://travis-ci.org/prismicio/csharp-kit)



### Getting started



#### Install the kit for your project



This kit can be installed using NuGet [prismic package](https://www.nuget.org/packages/prismicio/).

To install prismic from the [Package Manager Console](http://docs.nuget.org/docs/start-here/using-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](https://developers.prismic.io/documentation/UszOeAEAANUlwFpp/contribute-to-the-official-kits).)*



#### Get started with prismic.io



You can find out [how to get started with prismic.io](https://developers.prismic.io/documentation/UjBaQsuvzdIHvE4D/getting-started) on our [prismic.io developer's portal](https://developers.prismic.io/).



#### Get started using the kit



Also on our [prismic.io developer's portal](https://developers.prismic.io/), on top of our full documentation, you will:

* get a thorough introduction of [how to use prismic.io kits](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation#kits-and-helpers), including this one.



### 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](https://github.com/prismicio/csharp-kit/blob/master/Migration.md) document for more informations.



### Changelog



[ReleaseNodes.md](https://github.com/prismicio/csharp-kit/blob/master/ReleaseNotes.md).



### Contribute to the kit



Contribution is open to all developer levels, read our "[Contribute to the official kits](https://developers.prismic.io/documentation/UszOeAEAANUlwFpp/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](https://developers.prismic.io/documentation/UszOeAEAANUlwFpp/contribute-to-the-official-kits).)*



#### 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.