]> git.immae.eu Git - github/shaarli/Shaarli.git/blobdiff - README.md
PHP: ensure 5.3 compatibility, refactor timezone utilities
[github/shaarli/Shaarli.git] / README.md
index 6b5086f39ce5f88fd99124986b1ac73d52de1e81..b3dbaf5facb5c6c8e8cc3f9deb1eb0b6e8352903 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,11 @@
-![Shaarli logo](https://cdn.mediacru.sh/W2NGCIHB3quT.png)
+![Shaarli logo](doc/images/doc-logo.png)
 
 Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
 
 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.
 
+[![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)
 
 ## Features:
 
@@ -41,6 +42,12 @@ It is designed to be personal (single-user), fast and handy.
  * 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
 
@@ -50,7 +57,7 @@ It is designed to be personal (single-user), fast and handy.
 
 ## Installing
 
-Shaarli requires php 5.1
+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
@@ -62,9 +69,8 @@ _To get the development version, download https://github.com/shaarli/Shaarli/arc
 
 ## Upgrading
 
-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 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