Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitaly.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPablo Carranza <pcarranza@gmail.com>2016-12-20 20:04:57 +0300
committerPablo Carranza <pcarranza@gmail.com>2016-12-20 20:04:57 +0300
commitb54e4868ed47424a31c3bc21159ac2e1df4d32be (patch)
tree41d5149b848bb35c7f74aed7c3d9aa988bd57e0b
parent95a1fcb52ab9d9ffab1ccf73dcc0041a20393d9f (diff)
Add a summary to the initial README filepc-update-design
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index a0ebf7c10..61f94ca05 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,23 @@
# Gitaly
-- [Reasoning and design of Gitaly](design/README.md)
- [About the name Gitaly](#name)
+## Summary
+
+Gitaly is an abstraction and caching layer on top of Git. It serves as a GitRPC
+daemon that reduces IOPS by aggresively caching expensive git operations and providing
+an API so GitLab can perform queries for metadata and serve them directly from memory
+instead of reaching the filesystem.
+
+[Reasoning and design](design/README.md)
+
## Name
Gitaly is a tribute to git and the town of [Aly][aly-wiki]. Where the town of
Aly has zero inhabitants most of the year we would like to reduce the number of
disk operations to zero for most actions. It doesn't hurt that it sounds like
-Italy, the capital of which is [the destination of all roads][rome]. All git actions in
-GitLab end up in Gitaly.
+Italy, the capital of which is [the destination of all roads][rome].
+All git paths lead to Gitaly.
[aly-wiki]: https://en.wikipedia.org/wiki/Aly
[rome]: https://en.wikipedia.org/wiki/All_roads_lead_to_Rome