diff options
| author | Carlos MartÃn Nieto <carlosmn@github.com> | 2016-12-20 12:14:22 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-12-20 12:14:22 +0000 |
| commit | 329ce0439b38c03d2b887f1d12b8914a77c038e1 (patch) | |
| tree | f8503eafbe4a9df5ebe08760c45708ac4f9c51c6 /README.md | |
| parent | b0b850bfcafac9be84aacd4565368f5b87221926 (diff) | |
| parent | 8f064000dd85b72b8eb4d1baf41b1e6f1dc2f9ee (diff) | |
| download | libgit2-329ce0439b38c03d2b887f1d12b8914a77c038e1.tar.gz | |
Merge pull request #4037 from libgit2/cmn/goals
README: be more explicit in the goals and scope
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 11 insertions, 3 deletions
@@ -43,9 +43,17 @@ We ask that you not open a GitHub Issue for help, only for bug reports. What It Can Do ============== -`libgit2` is already very usable and is being used in production for many -applications including the GitHub.com site, in Plastic SCM and also powering -Microsoft's Visual Studio tools for Git. The library provides: +The goal of this library is to allow its users the ability to handle Git data in +their applications from their programming language of choice, as is used in +production for many applications including the GitHub.com site, in Plastic SCM +and also powering Microsoft's Visual Studio tools for Git. + +It does not aim to replace the git tool or its user-facing commands. Some APIs +resemble the plumbing commands as those align closely with the concepts of the +Git system, but most commands a user would type are out of scope for this +library to implement directly. + +The library provides: * SHA conversions, formatting and shortening * abstracted ODB backend system |