Skip to content

Commit

Permalink
Update roadmap.md
Browse files Browse the repository at this point in the history
  • Loading branch information
etolstoy authored Nov 16, 2016
1 parent 3aad59d commit 21cc6f0
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/2.x/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,10 +222,22 @@ Templates and tempalte catalogs, used for code generation, can be specified righ

```
ramba :viper_module do
catalog 'https://github.com/user/catalog', branch:'develop'
template 'viper_ios', version:'1.2.5'
template 'viper_ios2', path:'/local_templates'
end
```

- `catalog` keyword specifies a custom template catalog (like https://github.com/rambler-digital-solutions/generamba-catalog).
- `branch` parameter specifies a concrete catalog branch
- `template` keyword declares a template that needs to be installed
- `version` parameter specifies a concrete template version.
- `path` parameter specifies a local path to the template.
- `git` parameter specifies a remote repository path to a template.
- `branch` parameter is used together with `git` to specify a branch.

The `generamba template install` command aggregates all of the templates from the `Rambafile` and installs them in a `.generamba` hidden directory. When a user triggers some `ramba`, templates are loaded from this directory. The only exception are local templates - they are always installed from the specified in the `Rambafile` local path.

### Plugins

The main ideas behind plugin system are:
Expand Down

0 comments on commit 21cc6f0

Please sign in to comment.