aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-07-04 21:37:30 +0200
committerGitHub <noreply@github.com>2017-07-04 21:37:30 +0200
commit5b25a9635fe808bc1c4f3eee8cdf8485115da75d (patch)
treed5c46525f3c739d9c63de860427e0b3cadd688e5 /README.md
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
parent8bf94136e10c64496711c8f66a4f58f89c515360 (diff)
downloadShaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.gz
Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.zst
Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.zip
Merge pull request #772 from nodiscc/rtfd
Generate HTML documentation using MkDocs
Diffstat (limited to 'README.md')
-rw-r--r--README.md99
1 files changed, 5 insertions, 94 deletions
diff --git a/README.md b/README.md
index 7633b2cb..c9e83899 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
3The personal, minimalist, super-fast, database free, bookmarking service. 3The 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/badge/stable-v0.8.4-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.8.4) 9[![](https://img.shields.io/badge/stable-v0.8.4-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.8.4)
@@ -20,107 +20,18 @@ _It is designed to be personal (single-user), fast and handy._
20[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) 20[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
21 21
22## Quickstart 22## Quickstart
23- [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki) 23
24- [Documentation](https://shaarli.readthedocs.io)
24- [Change log](CHANGELOG.md) 25- [Change log](CHANGELOG.md)
25- [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) 26- [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
26 27
27### Demo 28### Demo
29
28You can use this [public demo instance of Shaarli](https://demo.shaarli.org). 30You can use this [public demo instance of Shaarli](https://demo.shaarli.org).
29It runs the latest development version of Shaarli and is updated/reset daily. 31It runs the latest development version of Shaarli and is updated/reset daily.
30 32
31Login: `demo`; Password: `demo` 33Login: `demo`; Password: `demo`
32 34
33### Installation & upgrade
34- [Download and installation](https://github.com/shaarli/Shaarli/wiki/Download-and-Installation)
35- [Upgrade and migration](https://github.com/shaarli/Shaarli/wiki/Upgrade-and-migration)
36- [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements)
37- [Server configuration](https://github.com/shaarli/Shaarli/wiki/Server-configuration)
38- [Shaarli configuration](https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration)
39
40## Features
41### Interface
42- minimalist design (simple is beautiful)
43- FAST
44- ATOM and RSS feeds
45- views:
46 - paginated link list
47 - tag cloud
48 - picture wall: image and video thumbnails
49 - daily: newspaper-like daily digest
50 - daily RSS feed
51- permalinks for easy reference
52- links can be public or private
53- extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage)
54
55### Tag, view and search your links!
56- add a custom title and description to archived links
57- add tags to classify and search links
58 - features tag autocompletion, renaming, merging and deletion
59- full-text and tag search
60
61### Easy setup
62- dead-simple installation: drop the files, open the page
63- links are stored in a file
64 - compact storage
65 - no database required
66 - easy backup: simply copy the datastore file
67- import and export links as Netscape bookmarks
68
69### Accessibility
70- Firefox bookmarlet to share links in one click
71- support for mobile browsers
72- works with Javascript disabled
73- easy page customization through HTML/CSS/RainTPL
74
75### Security
76- bruteforce-proof login form
77- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
78and session cookie hijacking
79
80### Goodies
81- thumbnail generation for images and video services:
82dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
83 - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
84- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
85- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
86- discreet pop-up notification when a new release is available
87
88### REST API
89
90Easily extensible by any client using the REST API exposed by Shaarli.
91
92See the [API documentation](http://shaarli.github.io/api-documentation/).
93
94### Other usages
95Though Shaarli is primarily a bookmarking application, it can serve other purposes
96(see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)):
97- micro-blogging
98- pastebin
99- online notepad
100- snippet archive
101
102## About
103### Shaarli community fork
104This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
105
106This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
107
108The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191)
109that he would have no time to work on Shaarli in the near future.
110The Shaarli community has carried on the work to provide
111[many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master)
112for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
113in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
114
115### Contributing
116If you'd like to help, please:
117- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
118and [pull requests](https://github.com/shaarli/Shaarli/pulls)
119- feel free to report bugs (feedback is much appreciated)
120- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
121- propose solutions to existing problems
122- submit pull requests :-)
123
124
125### License 35### License
36
126Shaarli 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. 37Shaarli 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.