library hack-sdk

prismic/hack-sdk

Hack development kit for prismic.io

Hack development kit for prismic.io

Getting started

Install the kit for your project

The best way to install the library is with the composer package manager (install it if you haven't yet), _(*1)

Then run this from your project's root in order to add the dependency:, _(*2)

composer require prismic/hack-sdk

If asked for a version, type in 'dev-master' (unless you want another version):, _(*3)

Please provide a version constraint for the prismic/hack-sdk requirement: dev-master

Usage in your Hack code:, _(*4)

<?hh

include_once __DIR__.'/../vendor/autoload.php';

use Prismic\Api;

Get started with prismic.io

You can find out how to get started with prismic.io on our prismic.io developer's portal., _(*5)

Get started using the kit

Also on our prismic.io developer's portal, on top of our full documentation, you will: * get a thorough introduction of how to use prismic.io kits, including this one., _(*6)

Contribute to the kit

Contribution is open to all developer levels, read our "Contribute to the official kits" documentation to learn more., _(*7)

Install the kit locally

Clone this GitHub repository, then install Composer if you haven't, and run:, _(*8)

composer install

Test

Please write tests for any bugfix or new feature., _(*9)

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., _(*10)

Documentation

Please document any bugfix or new feature., _(*11)

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., _(*12)

Licence

This software is licensed under the Apache 2 license, quoted below., _(*13)

Copyright 2013 Zengularity (http://www.zengularity.com)., _(*14)

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., _(*15)

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., _(*16)