aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2017-01-31 23:09:28 +0100
committerMáximo Cuadros <mcuadros@gmail.com>2017-01-31 23:09:52 +0100
commita6197bd8c459c7d10717bd9486c17f6c8b3f7f88 (patch)
tree63180ec210c66fda317c87197d2f6bab508406b6 /README.md
parent2308066c28d3cbbfb472fb634c3e10a1c7786cfc (diff)
downloadgo-git-a6197bd8c459c7d10717bd9486c17f6c8b3f7f88.tar.gz
documentation changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 5a379fc..00f88f5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# go-git [![GoDoc](https://godoc.org/srcd.works/go-git.v4?status.svg)](https://godoc.org/srcd.works/go-git.v4) [![Build Status](https://travis-ci.org/src-d/go-git.svg)](https://travis-ci.org/src-d/go-git) [![codecov.io](https://codecov.io/github/src-d/go-git/coverage.svg)](https://codecov.io/github/src-d/go-git) [![codebeat badge](https://codebeat.co/badges/b6cb2f73-9e54-483d-89f9-4b95a911f40c)](https://codebeat.co/projects/github-com-src-d-go-git)
-A low level and highly extensible git implementation in **pure Go**.
+A highly extensible git implementation 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.
@@ -27,7 +27,7 @@ go get -u srcd.works/go-git.v4/...
Examples
--------
-> Please note that the functions `CheckIfError` and `Info` used in the examples are from the [examples package](https://github.com/src-d/go-git/blob/master/examples/common.go#L17) just to be used in the examples.
+> Please note that the functions `CheckIfError` and `Info` used in the examples are from the [examples package](https://github.com/src-d/go-git/blob/master/_examples/common.go#L17) just to be used in the examples.
### Basic example
@@ -109,7 +109,7 @@ Date: Fri Nov 11 13:23:22 2016 +0100
...
```
-You can find this [example](examples/log/main.go) and many other at the [examples](examples) folder
+You can find this [example](_examples/log/main.go) and many other at the [examples](_examples) folder
Contribute
----------