Skip to content

Commit b1509a5

Browse files
committed
readme: minor language improvements
1 parent 0598cf3 commit b1509a5

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
# gitbase [![GitHub version](https://badge.fury.io/gh/src-d%2Fgitbase.svg)](https://github.com/mcuadros/ofelia/releases) [![Build Status](https://travis-ci.org/src-d/gitbase.svg?branch=master)](https://travis-ci.org/src-d/gitbase) [![codecov](https://codecov.io/gh/src-d/gitbase/branch/master/graph/badge.svg)](https://codecov.io/gh/src-d/gitbase) [![GoDoc](https://godoc.org/gopkg.in/src-d/gitbase.v0?status.svg)](https://godoc.org/gopkg.in/src-d/gitbase.v0) [![Go Report Card](https://goreportcard.com/badge/github.com/src-d/gitbase)](https://goreportcard.com/report/github.com/src-d/gitbase)
22

3-
**gitbase**, is a database interface to git repository.
3+
**gitbase**, is a SQL database interface to Git repositories.
44

5-
It can be used to perform SQL queries about the git history but as well about
6-
the code itself through the AST, on top or any number of git repository.
5+
It can be used to perform SQL queries about the Git history and
6+
about the [Universal AST](https://doc.bblf.sh/) of the code itself. gitbase is being built to work on top of any number of git repositories.
77

88
gitbase implements the *MySQL* wire protocol, it can be accessed using any MySQL
99
client or library from any language.
1010

1111
## Status
1212

13-
The project is currently in **alpha** stage, not being performance in many of the
14-
cases, but we are working hard on getting a performance system able to processes
13+
The project is currently in **alpha** stage, meaning it's still lacking performance in a number of cases but we are working hard on getting a performant system able to processes
1514
thousands of repositories in a single node. Stay tuned!
1615

1716
## Examples
@@ -68,7 +67,7 @@ GROUP BY committer_email, month, repo_id
6867

6968
### Installing from binaries
7069

71-
Check the [Releases](https://github.com/src-d/gitbase/releases) page to download the gitbase binary.
70+
Check the [Release](https://github.com/src-d/gitbase/releases) page to download the gitbase binary.
7271

7372
### Installing from source
7473

@@ -94,7 +93,7 @@ Available commands:
9493
version Show the version information.
9594
```
9695

97-
You can start a server using some repositores from `/path/to/repositories` with this command:
96+
You can start a server by providing a path which contains multiple git repositories `/path/to/repositories` with this command:
9897

9998
```
10099
$ gitbase server -v -g /path/to/repositories

0 commit comments

Comments
 (0)