summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRussell Belfer <rb@github.com>2012-07-10 21:50:36 -0700
committerRussell Belfer <rb@github.com>2012-07-10 21:50:36 -0700
commit6b9a49cd5fd6addc5b9ce3281ea33a50934f5a94 (patch)
tree45ce397e64d11d854306596a78fc237856e2b776
parentb173cda5bf91b3d344ba967973af960618b7f554 (diff)
downloadlibgit2-6b9a49cd5fd6addc5b9ce3281ea33a50934f5a94.tar.gz
Updating language in examples README
-rw-r--r--examples/README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/examples/README.md b/examples/README.md
index 38d1ed86b..f2b6d7d23 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,8 +1,11 @@
libgit2 examples
================
-These examples might don't work on all platforms and are meant as thin,
-easy-to-read snippets for docurium (https://github.com/github/docurium)
-rather than full-blown implementations of Git commands.
+These examples are meant as thin, easy-to-read snippets for Docurium
+(https://github.com/github/docurium) rather than full-blown
+implementations of Git commands. They are not vetted as carefully
+for bugs, error handling, or cross-platform compatibility as the
+rest of the code in libgit2, so copy with some caution.
+
+For HTML versions, check "Examples" at http://libgit2.github.com/libgit2
-For a HTML version check "Examples" at http://libgit2.github.com/libgit2