Skip to content

Commit 329ce04

Browse files
authored
Merge pull request libgit2#4037 from libgit2/cmn/goals
README: be more explicit in the goals and scope
2 parents b0b850b + 8f06400 commit 329ce04

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,17 @@ We ask that you not open a GitHub Issue for help, only for bug reports.
4343
What It Can Do
4444
==============
4545

46-
`libgit2` is already very usable and is being used in production for many
47-
applications including the GitHub.com site, in Plastic SCM and also powering
48-
Microsoft's Visual Studio tools for Git. The library provides:
46+
The goal of this library is to allow its users the ability to handle Git data in
47+
their applications from their programming language of choice, as is used in
48+
production for many applications including the GitHub.com site, in Plastic SCM
49+
and also powering Microsoft's Visual Studio tools for Git.
50+
51+
It does not aim to replace the git tool or its user-facing commands. Some APIs
52+
resemble the plumbing commands as those align closely with the concepts of the
53+
Git system, but most commands a user would type are out of scope for this
54+
library to implement directly.
55+
56+
The library provides:
4957

5058
* SHA conversions, formatting and shortening
5159
* abstracted ODB backend system

0 commit comments

Comments
 (0)