Skip to content

Commit 7612086

Browse files
committed
Update examples/README.md
1 parent 85c6730 commit 7612086

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

examples/README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
libgit2 examples
22
================
33

4-
These examples are meant as thin, easy-to-read snippets for Docurium
5-
(https://github.com/github/docurium) rather than full-blown
6-
implementations of Git commands. They are not vetted as carefully
7-
for bugs, error handling, or cross-platform compatibility as the
8-
rest of the code in libgit2, so copy with some caution.
4+
These examples are a mixture of basic emulation of core Git command line
5+
functions and simple snippets demonstrating libgit2 API usage (for use
6+
with Docurium). As a whole, they are not vetted carefully for bugs, error
7+
handling, and cross-platform compatibility in the same manner as the rest
8+
of the code in libgit2, so copy with caution.
99

10-
For HTML versions, check "Examples" at http://libgit2.github.com/libgit2
10+
That being said, you are welcome to copy code from these examples as
11+
desired when using libgit2.
1112

13+
For annotated HTML versions, see the "Examples" section of:
14+
15+
http://libgit2.github.com/libgit2
16+
17+
such as:
18+
19+
http://libgit2.github.com/libgit2/ex/HEAD/general.html

0 commit comments

Comments
 (0)