diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2016-12-19 13:54:55 +0000 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2016-12-19 13:54:55 +0000 |
| commit | 8f064000dd85b72b8eb4d1baf41b1e6f1dc2f9ee (patch) | |
| tree | 76b8482f19c1cf7df94760d2680750749a42ac5f | |
| parent | c655def1174f814c2adcafff7cecec4d47dc5830 (diff) | |
| download | libgit2-cmn/goals.tar.gz | |
README: be more explicit in the goals and scopecmn/goals
Make it clearer from the get-go that we do not aim to implement
user-facing commands from the git tool.
| -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 |