Skip to content
This repository has been archived by the owner on Mar 4, 2019. It is now read-only.

Fixed readme to describe this project #1

Open
wants to merge 1 commit into
base: kiwijs
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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.