X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=a5a3bba1ad4c55a25ffbac8c4de02aadabf8e43c;hb=53cc2b93b85a080c6c06bc3633fb454241fc5699;hp=0397621a4c4d06f5d3f8513935a60910a8a943d4;hpb=4891e2f77adc86a17284db0c7e8d57a0d8be834f;p=github%2Fshaarli%2FShaarli.git diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 0397621a..a5a3bba1 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ -![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. +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. -[![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![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) +[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) -## Features: +## Features * Minimalist design (simple is beautiful) * **FAST** @@ -42,6 +44,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 @@ -49,9 +57,11 @@ It is designed to be personal (single-user), fast and handy. * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) -## Installing +## Requirements -Shaarli requires php 5.1 +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 @@ -63,9 +73,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 @@ -78,4 +87,3 @@ This is a community fork of the original [Shaarli](https://github.com/sebsauvage ## 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. -