]> git.immae.eu Git - github/shaarli/Shaarli.git/blobdiff - README.md
Merge pull request #1234 from virtualtam/lint
[github/shaarli/Shaarli.git] / README.md
index b3dbaf5facb5c6c8e8cc3f9deb1eb0b6e8352903..0e23e33d395a1d8bf4d52b6c1af46ad1a5dc0fb2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,86 +1,37 @@
-![Shaarli logo](doc/images/doc-logo.png)
+![Shaarli logo](doc/md/images/doc-logo.png)
 
-Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
+The personal, minimalist, super-fast, database free, bookmarking service.
 
-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 link sharing service 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/badge/stable-v0.9.7-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.9.7)
+[![](https://img.shields.io/travis/shaarli/Shaarli/stable.svg?label=stable)](https://travis-ci.org/shaarli/Shaarli)
+•
+[![](https://img.shields.io/badge/latest-v0.10.2-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.10.2)
+[![](https://img.shields.io/travis/shaarli/Shaarli/latest.svg?label=latest)](https://travis-ci.org/shaarli/Shaarli)
+•
+[![](https://img.shields.io/badge/master-v0.10.x-blue.svg)](https://github.com/shaarli/Shaarli)
+[![](https://img.shields.io/travis/shaarli/Shaarli.svg?label=master)](https://travis-ci.org/shaarli/Shaarli)
 
-## Features:
+[![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)
+[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
 
- * 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)**
+## Quickstart
 
-## 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.
+- [Documentation](https://shaarli.readthedocs.io)
+- [Change log](CHANGELOG.md)
+- [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
 
-Login: `demo`
-Password: `demo`
+### Demo
 
+You can use this [public demo instance of Shaarli](https://demo.shaarli.org).
+It runs the latest development version of Shaarli and is updated/reset daily.
 
-## Links
+Login: `demo`; Password: `demo`
 
- * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)**
- * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
-
-
-## Installing
-
-Shaarli requires PHP 5.3. `php-gd` is optional and provides thumbnail resizing.
-
- * 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.
-
-_To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_
-
-
-## Upgrading
-
- * **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.
-
-
-## 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
+### 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.
-