README.md

   1 ![Shaarli logo](http://sebsauvage.net/wiki/lib/exe/fetch.php?media=php:php_shaarli:php_shaarli_logo_inkscape_w600_transp-nq8.png)
   2
   3 Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
   4
   5 You want to share the links you discover ? Shaarli is a minimalist delicious clone you can install on your own website.
   6 It is designed to be personal (single-user), fast and handy.
   7
   8
   9 Features:
  10
  11  * Minimalist design (simple is beautiful)
  12  * **FAST**
  13  * Dead-simple installation: Drop the files, open the page. No database required.
  14  * Easy to use: Single button in your browser to bookmark a page
  15  * Save URL, title, description (unlimited size). Classify links with tags (with autocomplete)
  16  * Tag renaming, merging and deletion.
  17  * Automatic thumbnails for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…)
  18  * Automatic conversion of URLs to clickable links in descriptions. Support for http/ftp/file/apt/magnet protocols.
  19  * Save links as public or private
  20  * 1-click access to your private links/notes
  21  * Browse links by page, filter by tag or use the full text search engine
  22  * Permalinks (with QR-Code) for easy reference
  23  * RSS and ATOM feeds (which can be filtered by tag or text search)
  24  * Tag cloud
  25  * Picture wall (which can be filtered by tag or text search)
  26  * “Links of the day” Newspaper-like digest, browsable by day.
  27  * “Daily” RSS feed: Get each day a digest of all new links.
  28  * [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
  29  * Easy backup (Data stored in a single file)
  30  * Compact storage (1315 links stored in 150 kb)
  31  * Mobile browsers support
  32  * Also works with javascript disabled
  33  * Can import/export Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…)
  34  * Brute force protected login form
  35  * Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery), session cookie hijacking.
  36  * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…)
  37  * Shaarli is a bookmarking application, but you can use it for micro-blogging (like Twitter), a pastebin, an online notepad, a snippet repository, etc.
  38  * You will be automatically notified by a discreet popup if a new version is available
  39  * Pages are easy to customize (using CSS and simple RainTPL templates)
  40
  41
  42 Requires php 5.1
  43
  44 More information on the project page:
  45 http://sebsauvage.net/wiki/doku.php?id=php:shaarli
  46
  47 ------------------------------------------------------------------------------
  48
  49 Shaarli is distributed under the zlib/libpng License:
  50
  51 Copyright (c) 2011 Sébastien SAUVAGE (sebsauvage.net)
  52
  53 This software is provided 'as-is', without any express or implied warranty.
  54 In no event will the authors be held liable for any damages arising from
  55 the use of this software.
  56
  57 Permission is granted to anyone to use this software for any purpose,
  58 including commercial applications, and to alter it and redistribute it
  59 freely, subject to the following restrictions:
  60
  61   1. The origin of this software must not be misrepresented; you must not
  62      claim that you wrote the original software. If you use this software
  63      in a product, an acknowledgment in the product documentation would
  64      be appreciated but is not required.
  65
  66   2. Altered source versions must be plainly marked as such, and must
  67      not be misrepresented as being the original software.
  68
  69   3. This notice may not be removed or altered from any source distribution.
  70
  71 ------------------------------------------------------------------------------