diff README @ 13:bd822f25e285 version-3

Add README file Add a README file with build instructions and a description
author Guido Berhoerster <guido+booket@berhoerster.name>
date Thu, 18 Sep 2014 20:35:42 +0200
parents
children 8445c729ba97
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Thu Sep 18 20:35:42 2014 +0200
@@ -0,0 +1,51 @@
+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/booket/booket.html "Booket"
+
+Build Instructions
+------------------
+
+Booket requires Scour, xmllint, and GNU make in order to strip down the
+included SVG images.
+
+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.