This repository was archived by the owner on Sep 11, 2020. It is now read-only.
README.md update #690
Merged
README.md update #690
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
orirawlings
suggested changes
Dec 12, 2017
Contributor
orirawlings
left a comment
orirawlings
left a comment
There was a problem hiding this comment.
Overall it looks really good. Just some minor grammar fixes. The links all seem to be working for me.
| @@ -1,18 +1,19 @@ | |||
| # go-git [](https://godoc.org/github.com/src-d/go-git) [](https://travis-ci.org/src-d/go-git) [](https://ci.appveyor.com/project/mcuadros/go-git) [](https://codecov.io/github/src-d/go-git) [](https://codebeat.co/projects/github-com-src-d-go-git) | |||
|  | |||
README.md
Outdated
| *go-git* is a highly extensible git implementation library written in **pure Go**. | ||
|
|
||
| *go-git* aims to reach the completeness of [libgit2](https://libgit2.github.com/) or [jgit](http://www.eclipse.org/jgit/), nowadays covers the **majority** of the plumbing **read operations** and **some** of the main **write operations**, but lacks the main porcelain operations such as merges. | ||
| It can be used to manipulate git repositories at low level *(plumbing)* or high level *(porcelain)*, through a idiomatic Go API. Also supports several type of storage, such us memory filesystems, or custom implementations thanks to the [`Storer`](https://godoc.org/gopkg.in/src-d/go-git.v4/plumbing/storer) interface. |
Contributor
There was a problem hiding this comment.
through "an" idiomatic
Contributor
There was a problem hiding this comment.
such "as" "in-"memory filesystems
README.md
Outdated
| *go-git* aims to be fully compatible with [git](https://github.com/git/git), all the *porcelain* operations are implemented to work exactly as *git* does. | ||
|
|
||
| If you are looking for a production ready version, please take a look to the [`v3`](https://github.com/src-d/go-git/tree/v3) which is being used in production at [source{d}](http://sourced.tech) since August 2015 to analyze all GitHub public repositories (i.e. 16M repositories). | ||
| *git* is a humongous project with years of development by thousands of contributors, making impossible to *go-git* implement all the features. You can find a comparison of *go-git* vs *git* in the [compatibility documentation](COMPATIBILITY.md). |
Contributor
There was a problem hiding this comment.
making "it challenging for" go-git to implement all the features
Signed-off-by: Máximo Cuadros <mcuadros@gmail.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Readme update for new v4 release.