cookbooks/nodejs_utils/README.md

   1 nodejs_utils Cookbook
   2 =====================
   3
   4 This cookbook installs `n`, `nvm` (Node.js Version Managers) setup scripts.
   5
   6 ## Contents
   7
   8 - [Requirements](#requirements)
   9     - [platforms](#platforms)
  10     - [packages](#packages)
  11     - [cookbooks](#cookbooks)
  12 - [Attributes](#attributes)
  13 - [Usage](#usage)
  14     - [Recipes](#recipes)
  15         - [nodejs_utils::default](#nodejs_utilsdefault)
  16         - [nodejs_utils::n-installer](#nodejs_utilsn-installer)
  17         - [nodejs_utils::nvm-installer](#nodejs_utilsnvm-installer)
  18 - [License and Authors](#license-and-authors)
  19
  20 ## Requirements
  21
  22 ### platforms
  23 - Debian >= 8.0
  24 - Ubuntu >= 14.04
  25 - CentOS, RHEL >= 7.3
  26
  27 ### packages
  28 - none.
  29
  30 ### cookbooks
  31 - none.
  32
  33 ## Attributes
  34
  35 |Key|Type|Description, example|Default|
  36 |:--|:--|:--|:--|
  37 |`['nodejs_utils']['nvm']['version']`|String|latest: 'master'|`'v0.33.6'`|
  38
  39 ## Usage
  40
  41 ### Recipes
  42
  43 #### nodejs_utils::default
  44
  45 This recipe does nothing.
  46
  47 #### nodejs_utils::n-installer
  48
  49 This recipe installs the `n` setup script.
  50
  51 #### nodejs_utils::nvm-installer
  52
  53 This recipe installs the `nvm` setup script.
  54
  55 ## License and Authors
  56
  57 - Author:: whitestar at osdn.jp
  58
  59 ```text
  60 Copyright 2017, whitestar
  61
  62 Licensed under the Apache License, Version 2.0 (the "License");
  63 you may not use this file except in compliance with the License.
  64 You may obtain a copy of the License at
  65
  66     http://www.apache.org/licenses/LICENSE-2.0
  67
  68 Unless required by applicable law or agreed to in writing, software
  69 distributed under the License is distributed on an "AS IS" BASIS,
  70 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  71 See the License for the specific language governing permissions and
  72 limitations under the License.
  73 ```