search

adaptivewebworks / prismicio-netstandard-kit

1 stars 2 forks source link

readme

.NET Standard development kit for prismic.io

Build Status

Release Build Status Code coverage

Alpha Build Status Code coverage

Getting started

Install the kit for your project

This kit can be installed using NuGet prismic package. For the latest stable build run the following shell command in your project folder:

dotnet package add prismicio.netstandard

(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 prismicio kit

Until October 2019, the prismic kit was only catered to .NET Framework. The new package has some breaking changes, primarily around API instantiation. Look at the sample project to see how to get an Api. Although every effort has been made to make the kit familiar new kit follows a more idiomatic C# coding style. When migrating a large code base to the new library, this gist might get your project building a little quicker. https://gist.github.com/benembery/f83800262f9713d01324273d2a7f1a12

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 2013-2014 Zengularity (http://www.zengularity.com).

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.