Permalink
Browse files

Add usage instructions

  • Loading branch information...
1 parent 981b0ca commit f1257d65d29ac4483b55810ee9e59e7db9139a54 @dougireton dougireton committed Dec 6, 2012
Showing with 11 additions and 4 deletions.
  1. +11 −4 README.md
View
@@ -35,10 +35,10 @@ The following attributes are platform-specific.
#### Windows
-* `node['git']['version']` - git version to install
-* `node['git']['url']` - URL to git package
-* `node['git']['checksum']` - package SHA256 checksum
-* `node['git']['display_name']` - `windows_package` resource Display Name (makes the package install idempotent)
+* `node['git']['version']` - git version to install
+* `node['git']['url']` - URL to git package
+* `node['git']['checksum']` - package SHA256 checksum
+* `node['git']['display_name']` - `windows_package` resource Display Name (makes the package install idempotent)
* `node['git']['setup_path_option']` - Add git and gitk to Windows Path (`Cmd`), Don't add git and gitk to Path (`BashOnly`), or add git, gitk, and git-related Unix tools to the path (`CmdTools`). Defaults to `Cmd`.
* `node['git']['setup_crlf_option']` - How should git handle line ending conversions (CRLF)? Checkout Windows-style, commit Unix-style line endings(`CRLFAlways`), Checkout as-is, commit Unix-style line endings(`LFOnly`), or Checkout as-is, commit as-is (`CRLFCommitAsIs`). Defaults to `CRLFAlways`.
@@ -76,9 +76,16 @@ Installs git client on Windows
Usage
=====
+
This cookbook primarily installs git core packages. It can also be
used to serve git repositories.
+To install git client (all supported platforms):
+
+ include_recipe 'git'
+
+To install git server:
+
include_recipe "git::server"
This creates the directory /srv/git and starts a git daemon, exporting

0 comments on commit f1257d6

Please sign in to comment.