Skip to content

Commit

Permalink
Add settings doc in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ZeroPointEnergy committed May 15, 2019
1 parent b990f31 commit 3980243
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,34 @@ Add the following line to your `Gemfile`:
gem 'ra10ke'
```

Add the following line in your `Rakefile`:
Add the following lines in your `Rakefile`:

```ruby
require 'ra10ke'
Ra10ke::RakeTask.new
```

## Configuration

You can configure the tasks in a block:

```ruby
Ra10ke::RakeTask.new do |t|
t.basedir = File.join(Dir.pwd, 'some_dir')
t.moduledir = File.join(Dir.pwd, 'some_dir/strange_module_dir')
end
```

Available settings are:

| Setting | Documentation |
|-----------------|-----------------------------------------------------------------------------------------------|
| basedir | Base directory with the Puppetfile and modules directory (Default: Same directory as Rakefile)|
| moduledir | Directory to install the modules in (Default: 'modules' in basedir) |
| puppetfile_path | Directroy where the Puppetfile is (Default: basedir) |
| puppetfile_name | The Puppetfile name (Default: basedir/Puppetfile) |
| force | Overwrite locally changed files on install (Default: false) |

## Rake tasks

### r10k:syntax
Expand Down

0 comments on commit 3980243

Please sign in to comment.