README.md in puppet-resource_api-1.4.1 vs README.md in puppet-resource_api-1.4.2
- old
+ new
@@ -1,10 +1,10 @@
# Puppet::ResourceApi [](https://travis-ci.org/puppetlabs/puppet-resource_api) [](https://ci.appveyor.com/project/puppetlabs/puppet-resource-api/branch/master) [](https://codecov.io/gh/puppetlabs/puppet-resource_api)
This is an implementation of the [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) proposal. Find a working example of a new-style provider in the [experimental puppetlabs-apt branch](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb). There is also the corresponding [type](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/type/apt_key2.rb), [provider](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/lib/puppet/provider/apt_key2/apt_key2.rb), and [new unit tests](https://github.com/DavidS/puppetlabs-apt/blob/resource-api-experiments/spec/unit/puppet/provider/apt_key2/apt_key2_spec.rb) for 100% coverage.
-## Install the Resource API
+## Getting Started
1. Download the [Puppet Development Kit](https://puppet.com/download-puppet-development-kit) (PDK) appropriate to your operating system and architecture.
2. Create a [new module](https://puppet.com/docs/pdk/latest/pdk_generating_modules.html) with the PDK, or work with an existing PDK-enabled module. To create a new module, run `pdk new module <MODULE_NAME>` from the command line, specifying the name of the module. Respond to the dialog questions.
@@ -45,11 +45,11 @@
$
```
5. Create the required files for a new type and provider in the module by running `pdk new provider <provider_name>`
-
+
You will get the following response:
```
$ pdk new provider foo
pdk (INFO): Creating '.../example/lib/puppet/type/foo.rb' from template.
@@ -80,16 +80,16 @@
Puppet::ResourceApi.register_type(
name: 'foo',
docs: <<-EOS,
This type provides Puppet with the capabilities to manage ...
EOS
- attributes: {
- ensure: {
+ attributes: {
+ ensure: {
type: 'Enum[present, absent]',
desc: 'Whether this apt key should be present or absent on the target system.',
default: 'present',
},
- name: {
+ name: {
type: 'String',
desc: 'The name of the resource you want to manage.',
behaviour: :namevar,
},
},