From 56462eb7312458eae2134e43e82f27ede9c2cafc Mon Sep 17 00:00:00 2001 From: "James A. Bednar" Date: Wed, 3 May 2017 15:34:41 -0500 Subject: [PATCH] Fixed readme to describe this project Previously described the C++ project it was forked from, not this one. --- README.rst | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 9410df77..af9b3e8f 100644 --- a/README.rst +++ b/README.rst @@ -1,11 +1,8 @@ -Welcome to Kiwi -=============== +Bokeh's JavaScript version of Kiwi +================================== -Kiwi is an efficient C++ implementation of the Cassowary constraint solving -algorithm. Kiwi is an implementation of the algorithm based on the seminal -Cassowary paper. It is *not* a refactoring of the original C++ solver. Kiwi -has been designed from the ground up to be lightweight and fast. Kiwi ranges -from 10x to 500x faster than the original Cassowary solver with typical use -cases gaining a 40x improvement. Memory savings are consistently > 5x. - -In addition to the C++ solver, Kiwi ships with hand-rolled Python bindings. +This package provides the Cassowary constraint solving algorithm +re-implemented in JavaScript so that it can be used for computing +layouts in client-side web applications like Bokeh. This version +started from the nucleic/kiwi C++ implementation of the algorithm, +but is now pure JavaScript.