diff options
author | ArthurHoaro <arthur@hoa.ro> | 2018-07-28 11:07:55 +0200 |
---|---|---|
committer | ArthurHoaro <arthur@hoa.ro> | 2018-07-28 11:07:55 +0200 |
commit | 83faedadff76c5bdca036f39f13943f63b27e164 (patch) | |
tree | 6f44cede16ec6a60f10b9699e211e0818f06d2c8 /README.md | |
parent | 1d9eb22a3df85b67fe6652c0876cd7382c2fb525 (diff) | |
parent | 658988f3aeba7a5a938783249ccf2765251e5597 (diff) | |
download | Shaarli-83faedadff76c5bdca036f39f13943f63b27e164.tar.gz Shaarli-83faedadff76c5bdca036f39f13943f63b27e164.tar.zst Shaarli-83faedadff76c5bdca036f39f13943f63b27e164.zip |
Merge tag 'v0.9.7' into stable
Release v0.9.7
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 108 |
1 files changed, 15 insertions, 93 deletions
@@ -1,115 +1,37 @@ | |||
1 | ![Shaarli logo](doc/images/doc-logo.png) | 1 | ![Shaarli logo](doc/md/images/doc-logo.png) |
2 | 2 | ||
3 | The personal, minimalist, super-fast, database free, bookmarking service. | 3 | The personal, minimalist, super-fast, database free, bookmarking service. |
4 | 4 | ||
5 | _Do you want to share the links you discover?_ | 5 | _Do you want to share the links you discover?_ |
6 | _Shaarli is a minimalist delicious clone that you can install on your own server._ | 6 | _Shaarli is a minimalist link sharing service that you can install on your own server._ |
7 | _It is designed to be personal (single-user), fast and handy._ | 7 | _It is designed to be personal (single-user), fast and handy._ |
8 | 8 | ||
9 | [![](https://img.shields.io/travis/shaarli/Shaarli.svg?label=master)](https://travis-ci.org/shaarli/Shaarli) | 9 | [![](https://img.shields.io/badge/stable-v0.8.5-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.8.5) |
10 | [![](https://img.shields.io/travis/shaarli/Shaarli/stable.svg?label=stable)](https://travis-ci.org/shaarli/Shaarli) | 10 | [![](https://img.shields.io/travis/shaarli/Shaarli/stable.svg?label=stable)](https://travis-ci.org/shaarli/Shaarli) |
11 | [![](https://img.shields.io/github/release/shaarli/shaarli.svg)](https://github.com/shaarli/Shaarli/releases/latest/) | 11 | • |
12 | [![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) | 12 | [![](https://img.shields.io/badge/latest-v0.9.4-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.9.4) |
13 | [![](https://img.shields.io/travis/shaarli/Shaarli/latest.svg?label=latest)](https://travis-ci.org/shaarli/Shaarli) | ||
14 | • | ||
15 | [![](https://img.shields.io/badge/master-v0.10.x-blue.svg)](https://github.com/shaarli/Shaarli) | ||
16 | [![](https://img.shields.io/travis/shaarli/Shaarli.svg?label=master)](https://travis-ci.org/shaarli/Shaarli) | ||
13 | 17 | ||
14 | [![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli) | 18 | [![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli) |
15 | [![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues) | 19 | [![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues) |
20 | [![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) | ||
16 | 21 | ||
17 | ## Quickstart | 22 | ## Quickstart |
18 | - [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki) | 23 | |
24 | - [Documentation](https://shaarli.readthedocs.io) | ||
19 | - [Change log](CHANGELOG.md) | 25 | - [Change log](CHANGELOG.md) |
20 | - [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) | 26 | - [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) |
21 | 27 | ||
22 | ### Demo | 28 | ### Demo |
23 | You can use this [public demo instance of Shaarli](http://shaarlidemo.tuxfamily.org/Shaarli). | 29 | |
30 | You can use this [public demo instance of Shaarli](https://demo.shaarli.org). | ||
24 | It runs the latest development version of Shaarli and is updated/reset daily. | 31 | It runs the latest development version of Shaarli and is updated/reset daily. |
25 | 32 | ||
26 | Login: `demo`; Password: `demo` | 33 | Login: `demo`; Password: `demo` |
27 | 34 | ||
28 | ### Installation & upgrade | ||
29 | - [Download and installation](https://github.com/shaarli/Shaarli/wiki/Download-and-Installation) | ||
30 | - [Upgrade and migration](https://github.com/shaarli/Shaarli/wiki/Upgrade-and-migration) | ||
31 | - [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements) | ||
32 | - [Server configuration](https://github.com/shaarli/Shaarli/wiki/Server-configuration) | ||
33 | - [Shaarli configuration](https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration) | ||
34 | |||
35 | ## Features | ||
36 | ### Interface | ||
37 | - minimalist design (simple is beautiful) | ||
38 | - FAST | ||
39 | - ATOM and RSS feeds | ||
40 | - views: | ||
41 | - paginated link list | ||
42 | - tag cloud | ||
43 | - picture wall: image and video thumbnails | ||
44 | - daily: newspaper-like daily digest | ||
45 | - daily RSS feed | ||
46 | - permalinks for easy reference | ||
47 | - links can be public or private | ||
48 | - extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage) | ||
49 | |||
50 | ### Tag, view and search your links! | ||
51 | - add a custom title and description to archived links | ||
52 | - add tags to classify and search links | ||
53 | - features tag autocompletion, renaming, merging and deletion | ||
54 | - full-text and tag search | ||
55 | |||
56 | ### Easy setup | ||
57 | - dead-simple installation: drop the files, open the page | ||
58 | - links are stored in a file | ||
59 | - compact storage | ||
60 | - no database required | ||
61 | - easy backup: simply copy the datastore file | ||
62 | - import and export links as Netscape bookmarks | ||
63 | |||
64 | ### Accessibility | ||
65 | - Firefox bookmarlet to share links in one click | ||
66 | - support for mobile browsers | ||
67 | - works with Javascript disabled | ||
68 | - easy page customization through HTML/CSS/RainTPL | ||
69 | |||
70 | ### Security | ||
71 | - bruteforce-proof login form | ||
72 | - protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) | ||
73 | and session cookie hijacking | ||
74 | |||
75 | ### Goodies | ||
76 | - thumbnail generation for images and video services: | ||
77 | dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube... | ||
78 | - lazy-loading with [bLazy](http://dinbror.dk/blazy/) | ||
79 | - [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support | ||
80 | - URL cleanup: automatic removal of `?utm_source=...`, `fb=...` | ||
81 | - discreet pop-up notification when a new release is available | ||
82 | |||
83 | ### Other usages | ||
84 | Though Shaarli is primarily a bookmarking application, it can serve other purposes | ||
85 | (see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)): | ||
86 | - micro-blogging | ||
87 | - pastebin | ||
88 | - online notepad | ||
89 | - snippet archive | ||
90 | |||
91 | ## About | ||
92 | ### Shaarli community fork | ||
93 | This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli | ||
94 | |||
95 | This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). | ||
96 | |||
97 | The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) | ||
98 | that he would have no time to work on Shaarli in the near future. | ||
99 | The Shaarli community has carried on the work to provide | ||
100 | [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) | ||
101 | for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) | ||
102 | in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. | ||
103 | |||
104 | ### Contributing | ||
105 | If you'd like to help, please: | ||
106 | - have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) | ||
107 | and [pull requests](https://github.com/shaarli/Shaarli/pulls) | ||
108 | - feel free to report bugs (feedback is much appreciated) | ||
109 | - suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki) | ||
110 | - propose solutions to existing problems | ||
111 | - submit pull requests :-) | ||
112 | |||
113 | |||
114 | ### License | 35 | ### License |
36 | |||
115 | 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. | 37 | 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. |