Skip to content

Commit 4265a7a

Browse files
ajnavarrogitbook-bot
authored andcommitted
GitBook: [master] 18 pages and 5 assets modified
1 parent 5baff93 commit 4265a7a

17 files changed

+211
-193
lines changed
142 KB
Loading
125 KB
Loading
125 KB
Loading
125 KB
Loading
142 KB
Loading

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# gitbase [![GitHub version](https://badge.fury.io/gh/src-d%2Fgitbase.svg)](https://github.com/src-d/gitbase/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)
1+
# Introduction
22

33
**gitbase**, is a SQL database interface to Git repositories.
44

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.
5+
It can be used to perform SQL queries about the Git history and 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.
76

8-
gitbase implements the *MySQL* wire protocol, it can be accessed using any MySQL
9-
client or library from any language.
7+
gitbase implements the _MySQL_ wire protocol, it can be accessed using any MySQL client or library from any language.
108

119
[src-d/go-mysql-server](https://github.com/src-d/go-mysql-server) is the SQL engine implementation used by `gitbase`.
1210

@@ -16,20 +14,21 @@ The project is currently in **alpha** stage, meaning it's still lacking performa
1614

1715
## Examples
1816

19-
You can see some [query examples](/docs/using-gitbase/examples.md) in [gitbase documentation](/docs).
17+
You can see some [query examples](using-gitbase/examples.md) in [gitbase documentation](https://github.com/src-d/gitbase/tree/f68dd7f644c24e3acba490a20c6c735b7770c54b/docs/README.md).
2018

2119
## Motivation and scope
2220

2321
gitbase was born to ease the analysis of git repositories and their source code.
2422

2523
Also, making it MySQL compatible, we provide the maximum compatibility between languages and existing tools.
2624

27-
It comes as a single self-contained binary and it can be used as a standalone service. The service is able to process local repositories or integrate with existing tools and frameworks (e.g. Apache Spark) to make source code analysis on a large scale.
25+
It comes as a single self-contained binary and it can be used as a standalone service. The service is able to process local repositories or integrate with existing tools and frameworks \(e.g. Apache Spark\) to make source code analysis on a large scale.
2826

2927
## Further reading
3028

31-
From here, you can directly go to [getting started](/docs/using-gitbase/getting-started.md).
29+
From here, you can directly go to [getting started](using-gitbase/getting-started.md).
3230

3331
## License
3432

35-
Apache License Version 2.0, see [LICENSE](LICENSE)
33+
Apache License Version 2.0, see [LICENSE](https://github.com/src-d/gitbase/tree/f68dd7f644c24e3acba490a20c6c735b7770c54b/LICENSE/README.md)
34+

docs/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# gitbase
1+
# Table of contents
22

3-
* [Join the community](join-the-community.md)
3+
* [Introduction](../README.md)
4+
* [Join the community](../join-the-community.md)
45

5-
### Using gitbase
6+
## Using gitbase
7+
8+
* [Getting started](../using-gitbase/getting-started.md)
9+
* [Configuration](../using-gitbase/configuration.md)
10+
* [Schema](../using-gitbase/schema.md)
11+
* [Supported syntax](../using-gitbase/supported-syntax.md)
12+
* [Functions](../using-gitbase/functions.md)
13+
* [Indexes](../using-gitbase/indexes.md)
14+
* [Examples](../using-gitbase/examples.md)
615

7-
* [Getting started](using-gitbase/getting-started.md)
8-
* [Configuration](using-gitbase/configuration.md)
9-
* [Schema](using-gitbase/schema.md)
10-
* [Supported syntax](using-gitbase/supported-syntax.md)
11-
* [Functions](using-gitbase/functions.md)
12-
* [Indexes](using-gitbase/indexes.md)
13-
* [Examples](using-gitbase/examples.md)

docs/using-gitbase/configuration.md

Lines changed: 0 additions & 83 deletions
This file was deleted.

docs/using-gitbase/functions.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/join-the-community.md renamed to join-the-community.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22

33
## Chat
44

5-
If you need support, want to contribute or just want to say hi, join us at the [source{d} community Slack](https://join.slack.com/t/sourced-community/shared_invite/enQtMjc4Njk5MzEyNzM2LTFjNzY4NjEwZGEwMzRiNTM4MzRlMzQ4MmIzZjkwZmZlM2NjODUxZmJjNDI1OTcxNDAyMmZlNmFjODZlNTg0YWM). We hang out in the #general channel.
5+
If you need support, want to contribute or just want to say hi, join us at the [source{d} community Slack](https://join.slack.com/t/sourced-community/shared_invite/enQtMjc4Njk5MzEyNzM2LTFjNzY4NjEwZGEwMzRiNTM4MzRlMzQ4MmIzZjkwZmZlM2NjODUxZmJjNDI1OTcxNDAyMmZlNmFjODZlNTg0YWM). We hang out in the \#general channel.
66

77
## Contributing
88

99
You can start contributing in many ways:
1010

11-
* [Report bugs](/docs/join-the-community.md#reporting-bugs)
11+
* [Report bugs](join-the-community.md#reporting-bugs)
1212
* [Request a feature](https://github.com/src-d/gitbase/issues)
1313
* Improve the [documentation](https://github.com/src-d/gitbase/docs)
1414
* Contribute code to [gitbase](https://github.com/src-d/gitbase)
1515

1616
## Reporting bugs
1717

1818
Bugs should be reported through [GitHub Issues](https://github.com/src-d/gitbase/issues).
19+

0 commit comments

Comments
 (0)