Skip to content

Commit b23cc9e

Browse files
committed
Improve readme
1 parent ff2415e commit b23cc9e

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ Deploys SSH keys
1616

1717
### Users
1818

19-
| Key | Type | Default | Description |
20-
| :------------------ |:---------- | :--------- | :-------------------------------------------------------------------- |
21-
| `authorized_keys` | Array | `[]` | Array of strings representing authorized SSH public keys |
22-
| `authorized_users` | Array | `[]` | Array of strings representing authorized users (found in the databag) |
19+
| Key | Type | Default | Description |
20+
| :------------------ |:---------- | :--------- | :-------------------------------------------------------------------------------- |
21+
| `authorized_keys` | Array | `[]` | Array of strings representing authorized SSH public keys |
22+
| `authorized_users` | Array | `[]` | Array of strings representing authorized users (found in the [databag](#databag)) |
2323

2424
## LWRP
2525

@@ -53,6 +53,13 @@ A keypais is described as follow:
5353

5454
## Usage
5555

56+
You can use this cookbook in tow ways:
57+
58+
* using the [`default`](#ssh-keys-default) recipe and providing (attributes)[#attributes]
59+
* using the [LWRP](#lwrp)
60+
61+
Both methods require you to define a [databag](#databag) to define SSH key pairs.
62+
5663
### ssh-keys::default
5764

5865
Include `ssh-keys` in your node's `run_list`:

0 commit comments

Comments
 (0)