summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorsnappy.mirrorbot@gmail.com <snappy.mirrorbot@gmail.com@03e5f5b5-db94-4691-08a0-1a8bf15f6143>2011-04-08 09:51:53 +0000
committersnappy.mirrorbot@gmail.com <snappy.mirrorbot@gmail.com@03e5f5b5-db94-4691-08a0-1a8bf15f6143>2011-04-08 09:51:53 +0000
commit69e3b45891cafc6f56be8cdaf398253b946d1015 (patch)
treebff2d87c3c5dfbd11275cc2ee7f895652df102c4 /README
parent6e0e69eab12e11f3712328f02184673085361c2d (diff)
downloadsnappy-69e3b45891cafc6f56be8cdaf398253b946d1015.tar.gz
Include C bindings of Snappy, contributed by Martin Gieseking.
I've made a few changes since Martin's version; mostly style nits, but also a semantic change -- most functions that return bool in the C++ version now return an enum, to better match typical C (and zlib) semantics. I've kept the copyright notice, since Martin is obviously the author here; he has signed the contributor license agreement, though, so this should not hinder Google's use in the future. We'll need to update the libtool version number to match the added interface, but as of http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html I'm going to wait until public release. R=csilvers DELTA=238 (233 added, 0 deleted, 5 changed) Revision created by MOE tool push_codebase. MOE_MIGRATION=1294 git-svn-id: http://snappy.googlecode.com/svn/trunk@27 03e5f5b5-db94-4691-08a0-1a8bf15f6143
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 6 insertions, 3 deletions
diff --git a/README b/README
index d69a450..df8f0e1 100644
--- a/README
+++ b/README
@@ -65,10 +65,13 @@ are of course most welcome; see "Contact", below.
Usage
=====
-Note that Snappy, both the implementation and the interface,
-is written in C++.
+Note that Snappy, both the implementation and the main interface,
+is written in C++. However, several third-party bindings to other languages
+are available; see the Google Code page at http://code.google.com/p/snappy/
+for more information. Also, if you want to use Snappy from C code, you can
+use the included C bindings in snappy-c.h.
-To use Snappy from your own program, include the file "snappy.h" from
+To use Snappy from your own C++ program, include the file "snappy.h" from
your calling file, and link against the compiled library.
There are many ways to call Snappy, but the simplest possible is