summaryrefslogtreecommitdiffstats
path: root/gin
diff options
context:
space:
mode:
Diffstat (limited to 'gin')
-rw-r--r--gin/README26
1 files changed, 21 insertions, 5 deletions
diff --git a/gin/README b/gin/README
index 82d0618..fc2d92e 100644
--- a/gin/README
+++ b/gin/README
@@ -1,8 +1,24 @@
Gin - Lightweight bindings for V8
=================================
-This directory contains gin, a lightweight bindings library for V8. These
-bindings are not compatible with the V8 bindings used by Blink because both
-want to control the v8::Isolate's internal data field. Maybe in some future
-world we'll refactor the Blink V8 bindings to use this system. In the meantime,
-these bindings are convenient for projects other than Blink that use V8.
+This directory contains Gin, a set of utilities to make working with V8 easier.
+
+Here are some of the key bits:
+
+* converter.h: Templatized JS<->C++ conversion routines for many common C++
+ types. You can define your own by specializing Converter.
+
+* function_template.h: Create JavaScript functions that dispatch to any C++
+ function, member function pointer, or base::Callback.
+
+* object_template_builder.h: A handy utility for creation of v8::ObjectTemplate.
+
+* wrappable.h: Base class for C++ classes that want to be owned by the V8 GC.
+ Wrappable objects are automatically deleted when GC discovers that nothing in
+ the V8 heap refers to them. This is also an easy way to expose C++ objects to
+ JavaScript.
+
+* runner.h: Create script contexts and run code in them.
+
+* module_runner_delegate.h: A delegate for runner that implements a subset of
+ the AMD module specification. Also see modules/ with some example modules.