Merge pull request #343 from virtualtam/readme

Rewrite README.md

1 files changed, 100 insertions, 75 deletions

diff --git a/README.md b/README.md
index a5a3bba1..9cc4773b 100755
--- a/README.md
+++ b/README.md
@@ -1,89 +1,114 @@
 ![Shaarli logo](doc/images/doc-logo.png)
 
-Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
+The personal, minimalist, super-fast, no-database delicious clone.
 
-Do you want to share the links you discover? Shaarli is a minimalist delicious clone you can install on your own website.
-It is designed to be personal (single-user), fast and handy.
+_Do you want to share the links you discover?_
+_Shaarli is a minimalist delicious clone that you can install on your own server._
+_It is designed to be personal (single-user), fast and handy._
 
-[![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli)
-[![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues) [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli)
+[![](https://img.shields.io/travis/shaarli/Shaarli.svg?label=master)](https://travis-ci.org/shaarli/Shaarli)
+[![](https://img.shields.io/travis/shaarli/Shaarli/stable.svg?label=stable)](https://travis-ci.org/shaarli/Shaarli)
+[![](https://img.shields.io/github/release/shaarli/shaarli.svg)](https://github.com/shaarli/Shaarli/releases/latest/)
 [![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
 
-## Features
-
- * Minimalist design (simple is beautiful)
- * **FAST**
- * Dead-simple installation: Drop the files, open the page. No database required.
- * Easy to use: Single button in your browser to bookmark a page (**bookmarklet**)
- * Save **URL, title, description** (unlimited size).
- * Classify, search and filter links with **tags**.
-  * Tag autocompletion, renaming, merging and deletion.
- * Save links as **public or private**
- * Browse links by page, filter by tag or use the **full text search engine**
- * **Tag cloud**
- * **Picture wall** (which can be filtered by tag or text search)
- * **“Daily”** Newspaper-like digest, browsable by day.
- * **Permalinks** (with QR-Code) for easy reference
- * **RSS** and ATOM feeds
-  * Can be filtered by tag or text search!
-  * “Daily” RSS feed: Get each day a digest of all new links.
- * Can **import/export** Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…)
- * Automatic **image/video thumbnails** for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…)
- * Support for http/ftp/file/apt/magnet protocol links
-  * URLs in descriptions are automatically converted to clickable links in descriptions
- * Easy backup (Data stored in a single file)
- * 1-click access to your private links/notes
- * Compact storage (1315 links stored in 150 kb)
- * Mobile browsers support
- * Also works with javascript disabled
- * Brute force protected login form
- * [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
- * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…)
- * Pages are easy to customize (using CSS and simple RainTPL templates)
- * Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery), session cookie hijacking.
- * You will be automatically notified by a discreet popup if a new version is available
- * **Shaarli is a bookmarking application, but you can use it for micro-blogging (like Twitter), a pastebin, an online notepad, a snippet repository, etc. See [Usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)**
-
-## Demo
-You can use this [public demo instance of Shaarli](http://shaarlidemo.tuxfamily.org/Shaarli). This demo runs the latest _development version_ of Shaarli and is updated/reset every day.
-
-Login: `demo`
-Password: `demo`
-
-
-## Links
-
- * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)**
- * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
-
-
-## Requirements
-
-Check the [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements) wiki page.
-
-## Installing
-
- * Download the latest stable release from https://github.com/shaarli/Shaarli/releases
- * Unpack the archive in a directory on your web server
- * Visit this directory from a web browser.
- * Choose login, password, timezone and page title. Save.
+[![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli)
+[![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues)
 
-_To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_
+## Quickstart
+- [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)
+- [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
 
+### Demo
+You can use this [public demo instance of Shaarli](http://shaarlidemo.tuxfamily.org/Shaarli).
+It runs the latest development version of Shaarli and is updated/reset daily.
 
-## Upgrading
+Login: `demo`; Password: `demo`
 
- * **If you installed from the zip:** Delete all files and directories except the `data` directory, then unzip the new version of Shaarli.  You will not lose your links and you will not have to reconfigure it.
- * **If you installed using `git clone`**: run `git pull` in your Shaarli directory.
+### Installation & upgrade
+- [Download](https://github.com/shaarli/Shaarli/wiki/Download)
+- [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements)
+- [Server configuration](https://github.com/shaarli/Shaarli/wiki/Server-configuration)
+- [Shaarli configuration](https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration)
 
+## Features
+### Interface
+- minimalist design (simple is beautiful)
+- FAST
+- ATOM and RSS feeds
+- views:
+    - paginated link list
+    - tag cloud
+    - picture wall: image and video thumbails
+    - daily: newspaper-like daily digest
+    - daily RSS feed
+- permalinks for easy reference
+- links can be public or private
+
+### Tag, view and search your links!
+- add a custom title and description to archived links
+- add tags to classify and search links
+    - features tag autocompletion, renaming, merging and deletion
+- full-text and tag search
+
+### Easy setup
+- dead-simple installation: drop the files, open the page
+- links are stored in a file
+    - compact storage
+    - no database required
+    - easy backup: simply copy the datastore file
+- import and export links as Netscape bookmarks
+
+### Accessibility
+- Firefox bookmarlet to share links in one click
+- support for mobile browsers
+- works with Javascript disabled
+- easy page customization through HTML/CSS/RainTPL
+
+### Security
+- bruteforce-proof login form
+- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
+and session cookie hijacking
+
+### Goodies
+- thumbnail generation for images and video services:
+dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
+    - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
+- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
+- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
+- discreet pop-up notification when a new release is available
+
+### Other usages
+Though Shaarli is primarily a bookmarking application, it can serve other purposes
+(see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)):
+- micro-blogging
+- pastebin
+- online notepad
+- snippet archive
 
 ## About
-
-This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli
-
-This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [sebsauvage](http://sebsauvage.net/). The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) that he would have no time to work on Shaarli in the near future. The Shaarli community has carried on the work to provide [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. If you'd like to help, have a look at the current [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls) and feel free to report bugs and feature requests, propose solutions to existing problems and send us pull requests. 
-
-
-## License
-
+### Shaarli community fork
+This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
+
+This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
+
+The original project is currently unmaintained, and the developer
+[has informed us](https://github.com/sebsauvage/Shaarli/issues/191) that he would
+have no time to work on Shaarli in the near future.
+The Shaarli community has carried on the work to provide
+[many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master)
+for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
+in this repository, and will keep maintaining the project for the foreseeable future,
+while keeping Shaarli simple and efficient.
+
+### Contributing
+If you'd like to help, please:
+- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
+and [pull requests](https://github.com/shaarli/Shaarli/pulls)
+- feel free to report bugs (feedback is much appreciated)
+- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
+- propose solutions to existing problems
+- submit pull requests :-)
+
+
+### License
 Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See [COPYING](COPYING) for a detail of the contributors and licenses for each individual component.