RoboticCheese/iwork-chef

View on GitHub
README.md

Summary

Maintainability
Test Coverage
iWork Cookbook
==============
[![Cookbook Version](https://img.shields.io/cookbook/v/iwork.svg)][cookbook]
[![Build Status](https://img.shields.io/travis/RoboticCheese/iwork-chef.svg)][travis]
[![Code Climate](https://img.shields.io/codeclimate/github/RoboticCheese/iwork-chef.svg)][codeclimate]
[![Coverage Status](https://img.shields.io/coveralls/RoboticCheese/iwork-chef.svg)][coveralls]

[cookbook]: https://supermarket.chef.io/cookbooks/iwork
[travis]: https://travis-ci.org/RoboticCheese/iwork-chef
[codeclimate]: https://codeclimate.com/github/RoboticCheese/iwork-chef
[coveralls]: https://coveralls.io/r/RoboticCheese/iwork-chef

A Chef cookbook to install the iWork productivity apps.

Requirements
============

This cookbook offers recipe-based and resource-based installs. Use of the
resources requires that you open a `mac_app_store` resource prior in your Chef
run.

Usage
=====

Either add one of the recipes to your run_list, or implement the resource in a
recipe of your own.

Recipes
=======

***default***

Install all of the apps.

Resources
=========

***keynote_app***

Used to perform installation of the Keynote app.

Syntax:

    keynote_app 'default' do
        action :install
    end

Actions:

| Action     | Description     |
|------------|-----------------|
| `:install` | Install the app |
| `:upgrade` | Upgrade the app |

Attributes:

| Attribute  | Default        | Description          |
|------------|----------------|----------------------|
| action     | `:install`     | Action(s) to perform |

***numbers_app***

Used to perform installation of the Numbers app.

Syntax:

    numbers_app 'default' do
        action :install
    end

Actions:

| Action     | Description     |
|------------|-----------------|
| `:install` | Install the app |
| `:upgrade` | Upgrade the app |

Attributes:

| Attribute  | Default        | Description          |
|------------|----------------|----------------------|
| action     | `:install`     | Action(s) to perform |

***pages_app***

Used to perform installation of the Pages app.

Syntax:

    pages_app 'default' do
        action :install
    end

Actions:

| Action     | Description     |
|------------|-----------------|
| `:install` | Install the app |
| `:upgrade` | Upgrade the app |

Attributes:

| Attribute  | Default        | Description          |
|------------|----------------|----------------------|
| action     | `:install`     | Action(s) to perform |

Contributing
============

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Add tests for the new feature; ensure they pass (`rake`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request

License & Authors
=================
- Author: Jonathan Hartman <j@p4nt5.com>

Copyright 2015-2016, Jonathan Hartman

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file 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.