@@ -17,6 +17,14 @@ command line. The API can be used for working with Git in complex interactions
17
17
including branching and merging, object inspection and manipulation, history, patch
18
18
generation and more.
19
19
20
+ Get started by obtaining a repository object by:
21
+
22
+ * opening an existing working copy with [ Git.open] ( https://rubydoc.info/gems/git/Git#open-class_method )
23
+ * initializing a new repository with [ Git.init] ( https://rubydoc.info/gems/git/Git#init-class_method )
24
+ * cloning a repository with [ Git.clone] ( https://rubydoc.info/gems/git/Git#clone-class_method )
25
+
26
+ Methods that can be called on a repository object are documented in [ Git::Base] ( https://rubydoc.info/gems/git/Git/Base )
27
+
20
28
## v2.0.0 pre-release
21
29
22
30
git 2.0.0 is available as a pre-release version for testing! Please give it a try.
@@ -41,36 +49,19 @@ the feedback received during the pre-release period.
41
49
The ` master ` branch will be used for ` 2.x ` development. If needed, fixes for ` 1.x `
42
50
version will be done on the ` v1 ` branch.
43
51
44
- ## Homepage
45
-
46
- The project source code is at:
47
-
48
- http://github.com/ruby-git/ruby-git
49
-
50
- ## Documentation
51
-
52
- Detailed documentation can be found at:
53
-
54
- https://rubydoc.info/gems/git/Git.html
55
-
56
- Get started by obtaining a repository object by:
57
-
58
- * opening an existing working copy with [ Git.open] ( https://rubydoc.info/gems/git/Git#open-class_method )
59
- * initializing a new repository with [ Git.init] ( https://rubydoc.info/gems/git/Git#init-class_method )
60
- * cloning a repository with [ Git.clone] ( https://rubydoc.info/gems/git/Git#clone-class_method )
61
-
62
- Methods that can be called on a repository object are documented in [ Git::Base] ( https://rubydoc.info/gems/git/Git/Base )
63
-
64
52
## Install
65
53
66
- You can install Ruby/Git like this :
54
+ Install the gem and add to the application's Gemfile by executing :
67
55
68
- ```
69
- sudo gem install git
56
+ ``` shell
57
+ bundle add git
70
58
```
71
59
72
- ## Code Status
60
+ If bundler is not being used to manage dependencies, install the gem by executing:
73
61
62
+ ``` shell
63
+ gem install git
64
+ ```
74
65
75
66
## Major Objects
76
67
@@ -103,12 +94,6 @@ Pass the `--all` option to `git log` as follows:
103
94
104
95
Here are a bunch of examples of how to use the Ruby/Git package.
105
96
106
- Ruby < 1.9 will require rubygems to be loaded.
107
-
108
- ``` ruby
109
- require ' rubygems'
110
- ```
111
-
112
97
Require the 'git' gem.
113
98
``` ruby
114
99
require ' git'
@@ -422,6 +407,14 @@ g.with_temp_working(dir) do
422
407
end
423
408
```
424
409
410
+ ## Ruby version support policy
411
+
412
+ This gem will be expected to function correctly on:
413
+
414
+ * All non-EOL versions of the MRI Ruby on Mac, Linux, and Windows
415
+ * The latest version of JRuby on Linux and Windows
416
+ * The latest version of Truffle Ruby on Linus
417
+
425
418
## License
426
419
427
420
licensed under MIT License Copyright (c) 2008 Scott Chacon. See LICENSE for further details.
0 commit comments