summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThe Bundler Bot <bot@bundler.io>2017-04-25 21:49:23 +0000
committerSamuel Giddins <segiddins@segiddins.me>2017-04-30 18:34:43 -0500
commit87f81f3dfe47661ad74738eec15fdb2e0bbe1989 (patch)
treeb131bfe8ae64305ad263b62630d02a6af516c383
parent46662845e0f668320bea87761d2fde9b5e95fa34 (diff)
downloadbundler-87f81f3dfe47661ad74738eec15fdb2e0bbe1989.tar.gz
Auto merge of #5610 - denniss:ds-add-doc, r=colby-swandale
[Documentation] `bundle add` documentation (cherry picked from commit a270b29445e31b6b0dff7201686950c28731a0ab)
-rw-r--r--man/bundle-add.ronn29
1 files changed, 29 insertions, 0 deletions
diff --git a/man/bundle-add.ronn b/man/bundle-add.ronn
new file mode 100644
index 0000000000..f0f9b54d8f
--- /dev/null
+++ b/man/bundle-add.ronn
@@ -0,0 +1,29 @@
+bundle-add(1) -- Add gem to the Gemfile and run bundle install
+================================================================
+
+## SYNOPSIS
+
+`bundle add` <GEM_NAME> [--group=GROUP] [--version=VERSION] [--source=SOURCE]
+
+## DESCRIPTION
+Adds the named gem to the Gemfile and run `bundle install`.
+
+Example:
+
+bundle add rails
+
+bundle add rails --version "< 3.0, > 1.1"
+
+bundle add rails --version "~> 5.0.0" --source "https://gems.example.com" --group "development"
+
+bundle add rails --group "development, test"
+
+## OPTIONS
+* `--version`, `-v`:
+ Specify version requirements(s) for the added gem.
+
+* `--group`, `-g`:
+ Specify the group(s) for the added gem. Multiple groups should be separated by commas.
+
+* `--source`, , `-s`:
+ Specify the source for the added gem.