X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=0e23e33d395a1d8bf4d52b6c1af46ad1a5dc0fb2;hb=1004742f09b55ff781c13745781b9a7e90986faa;hp=8f3c479b4a49cd32b2526286597e8ed9f14ad2f5;hpb=310f3ca0079a03eaa627f94b65486e4547aeb3d9;p=github%2Fshaarli%2FShaarli.git diff --git a/README.md b/README.md index 8f3c479b..0e23e33d 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,37 @@ -![Shaarli logo](http://sebsauvage.net/wiki/lib/exe/fetch.php?media=php:php_shaarli:php_shaarli_logo_inkscape_w600_transp-nq8.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._ +[![](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 - * Save url, title, description (unlimited size). Classify links with tags (with autocomplete) - * Tag renaming, merging and deletion. - * Automatic thumbnails for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…) - * Automatic conversion of URLs to clickable links in descriptions. Support for http/ftp/file/apt protocols. - * Save links as public or private - * 1-clic access to your private links/notes - * Browse links by page, filter by tag or use the full text search engine - * Permalinks (with QR-Code) for easy reference - * Tag cloud - * Picture wall (which can be filtered by tag or text search) - * “Links of the day” Newspaper-like digest, browsable by day. - * “Daily” RSS feed: Get each day a digest of all new links. - * RSS and ATOM feeds (which can be filtered by tag or text search) - * PubSubHubbub protocol support - * Easy backup (Data stored in a single file) - * Compact storage (1315 links stored in 150 kb) - * Mobile browsers support - * Can import/export Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…) - * Automatic ban of IP address upon too many failed logins - * Protected against XSRF, session cookie hijacking. - * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…) - * Shaarli is a bookmarking application, but you can use it for micro-blogging (like Twitter), a pastebin, an online notepad, a snippet repository, etc. - * You will be automatically notified by a discreet popup if a new version is available - * Pages are easy to customize (using simple RainTPL templates) +## Quickstart +- [Documentation](https://shaarli.readthedocs.io) +- [Change log](CHANGELOG.md) +- [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) -Requires php 5.1 (php 5.2 required for autocomplete.) +### Demo -More information on the project page: -http://sebsauvage.net/wiki/doku.php?id=php: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` -Shaarli is distributed under the zlib/libpng License: +### License -Copyright (c) 2011 Sébastien SAUVAGE (sebsauvage.net) - -This software is provided 'as-is', without any express or implied warranty. -In no event will the authors be held liable for any damages arising from -the use of this software. - -Permission is granted to anyone to use this software for any purpose, -including commercial applications, and to alter it and redistribute it -freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would - be appreciated but is not required. - - 2. Altered source versions must be plainly marked as such, and must - not be misrepresented as being the original software. - - 3. This notice may not be removed or altered from any source distribution. - ------------------------------------------------------------------------------- +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.