Install the kit
You can install a stable version using npm:
npm install prismic.io
Or using bower:
bower install prismic.io
Get started with prismic.io
Get started using the kit
Need to see what changed, or to upgrade your kit? We keep our changelog on this repository's "Releases" tab.
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
grunt command (it will make sure all tests still pass, and concatenate/minify your changes).
To install grunt and other required packages: install Node.js and npm, and then run this from your kit's repository, as an administrator:
npm install -g grunt npm install
Execute the tests either by opening test/test.html in a browser, or by running
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.
Please document any new feature or bugfix using the JSDoc syntax. You don't need to generate the documentation, we'll do that.
If you feel an existing area of code is lacking documentation, feel free to write it; but please do so on its own branch and pull-request.
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.
This software is licensed under the Apache 2 license, quoted below.
Copyright 2013 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.