X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=7633b2cbaa1f4fa7ef50524cbc5e1adb4d26263f;hb=460ce50115e5f5a1183c3c410fd76636ee5c4716;hp=a693e47ae5472d2aa97a0bdd4d6aed8783f3e4f4;hpb=cd5c1028920a096cefc4b2dc3c15bb18c07d9101;p=github%2Fshaarli%2FShaarli.git diff --git a/README.md b/README.md old mode 100755 new mode 100644 index a693e47a..7633b2cb --- a/README.md +++ b/README.md @@ -1,31 +1,38 @@ ![Shaarli logo](doc/images/doc-logo.png) -The personal, minimalist, super-fast, no-database delicious clone. +The personal, minimalist, super-fast, database free, bookmarking service. _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._ -[![](https://img.shields.io/travis/shaarli/Shaarli.svg?label=master)](https://travis-ci.org/shaarli/Shaarli) +[![](https://img.shields.io/badge/stable-v0.8.4-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.8.4) [![](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/) +• +[![](https://img.shields.io/badge/latest-v0.9.0-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.9.0) +[![](https://img.shields.io/travis/shaarli/Shaarli/latest.svg?label=latest)](https://travis-ci.org/shaarli/Shaarli) +• +[![](https://img.shields.io/badge/master-v0.9.x-blue.svg)](https://github.com/shaarli/Shaarli) +[![](https://img.shields.io/travis/shaarli/Shaarli.svg?label=master)](https://travis-ci.org/shaarli/Shaarli) [![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/) ## Quickstart - [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki) +- [Change log](CHANGELOG.md) - [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). +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. Login: `demo`; Password: `demo` ### Installation & upgrade -- [Download](https://github.com/shaarli/Shaarli/wiki/Download) +- [Download and installation](https://github.com/shaarli/Shaarli/wiki/Download-and-Installation) +- [Upgrade and migration](https://github.com/shaarli/Shaarli/wiki/Upgrade-and-migration) - [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) @@ -43,6 +50,7 @@ Login: `demo`; Password: `demo` - daily RSS feed - permalinks for easy reference - links can be public or private +- extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage) ### Tag, view and search your links! - add a custom title and description to archived links @@ -77,6 +85,12 @@ dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube... - URL cleanup: automatic removal of `?utm_source=...`, `fb=...` - discreet pop-up notification when a new release is available +### REST API + +Easily extensible by any client using the REST API exposed by Shaarli. + +See the [API documentation](http://shaarli.github.io/api-documentation/). + ### 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)):