Skip to content

Commit

Permalink
Bump to 1.0.0
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
afaundez committed Feb 9, 2018
1 parent 168d85b commit fdc7a97
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Chef resource for [nodenv](https://github.com/nodenv/nodenv) installs, configura
cookbook 'nodenv', '~> 1.0.0'
```

## Usage
## Resources

You can choose whether a user or a system install (or both). Check [test recipes](/test/fixtures/cookbooks/test/recipes) for working examples.

Expand All @@ -21,13 +21,25 @@ You can choose whether a user or a system install (or both). Check [test recipes
```ruby
nodenv_user 'user'
```
|Property|Type|Default|Details|
|-|-|-|
|`:user`|String||must be and existing user|
|`:nodenv_root`|String|`:user`'s home|A directory that must be writable by `:user`|
|`:git_url`|String|https://github.com/nodenv/nodenv.git|a valid git url|
|`:git_revision`|String|master|choose a branch|

#### System-wide

```ruby
nodenv_system 'system'
```

|Property|Type|Default|Details|
|-|-|-|
|`:nodenv_root`|String|`/usr/local/nodenv`||
|`:git_url`|String|https://github.com/nodenv/nodenv.git|a valid git url|
|`:git_revision`|String|master|choose a branch|

### Commands

Commands without `user` property will assume system-wide installation.
Expand All @@ -44,6 +56,10 @@ end
nodenv_install '9.5.0'
```

|Property|Type|Default|Details|
|-|-|-|
|`:version`|String||must be a valid [node version](https://nodejs.org/en/download/releases/), acts as name property|
|`:user`|String|`root`|must be an existing user|
#### Global

Set a global node version for user/system-wide nodenv.
Expand All @@ -56,6 +72,10 @@ end
nodenv_global '9.5.0'
```

|Property|Type|Default|Details|
|-|-|-|
|`:version`|String||must be installed node versions, acts as name property|
|`:user`|String|`root`|must be an existing user|

## Testing

Expand Down
2 changes: 1 addition & 1 deletion metadata.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
license 'MIT'
description 'Installs/Configures nodenv'
long_description 'Installs/Configures nodenv'
version '0.1.5'
version '1.0.0'
chef_version '>= 12.1' if respond_to?(:chef_version)

issues_url 'https://github.com/afaundez/nodenv-cookbook/issues'
Expand Down

0 comments on commit fdc7a97

Please sign in to comment.