Booket
======

Description
-----------

Booket is a browser-agnostic and portable bookmark manager with a focus on
simplicity which runs entirely locally in the browser. Bookmarks can be loaded
from and saved to a local file in a simple JSON-based file format. For
interoperability with browsers' native bookmarks Booket can also import and
export bookmarks in the Netscape file format. Bookmarks can be categorized
with tags allowing them to be easily located later through the built-in tag
filter and search function. Booket is implemented in HTML5, ECMAScript 5.1,
SVG 1.1 and CSS3 and works in all major recent browsers except Internet
Explorer, it can be placed and run from local storage or [from a
webserver][1].

[1]: http://code.guido-berhoerster.org/projects/booket/booket.html "Booket"

Build Instructions
------------------

Distributions of released versions already include pregenerated images.

The following tools are required to (re)generate the SVG and PNG images from
their sources:

- GNU make >= 3.81
- rsvg-convert from librsvg
- Scour
- xmllint

The following instructions assume that `make` is GNU make, on some platforms
it may be installed under a different name or a non-default path.  In order to
start the build process run `make all`.

Previously generated images can be removed by running `make clean`.

Contact
-------

Please send any feedback, translations or bug reports via email to
<guido+booket@berhoerster.name>.

Bug Reports
-----------

When sending bug reports, please always mention the exact version of Booket
with which the issue occurs as well as the version of the browser and
operating system you are using and make sure that you provide sufficient
information to reproduce the issue and include any input, output, any error
messages.

In case of build issues, please also specify the implementations and versions
of the tools you are using.

License
-------

Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
distributed under the following license terms:

Copyright (C) 2014 Guido Berhoerster <guido+booket@berhoerster.name>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.