aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md99
-rw-r--r--doc/md/index.md109
2 files changed, 111 insertions, 97 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.
diff --git a/doc/md/index.md b/doc/md/index.md
index 37a9c1fc..1106334b 100644
--- a/doc/md/index.md
+++ b/doc/md/index.md
@@ -1,11 +1,114 @@
1Welcome to the [Shaarli](https://github.com/shaarli/Shaarli/) wiki! 1# [Shaarli](https://github.com/shaarli/Shaarli/) documentation
2 2
3Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. 3Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
4 4
5For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). 5For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).
6 6
7If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). 7If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) or read the current [issues](https://github.com/shaarli/Shaarli/issues).
8If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
8 9
9If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin). 10If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin).
10 11
11_Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ 12_Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the `doc/html/` directory of your Shaarli installation._
13
14[![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)
16[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
17
18### Demo
19
20You can use this [public demo instance of Shaarli](https://demo.shaarli.org).
21It runs the latest development version of Shaarli and is updated/reset daily.
22
23Login: `demo`; Password: `demo`
24
25
26## Features
27
28### Interface
29- minimalist design (simple is beautiful)
30- FAST
31- ATOM and RSS feeds
32- views:
33 - paginated link list
34 - tag cloud
35 - picture wall: image and video thumbnails
36 - daily: newspaper-like daily digest
37 - daily RSS feed
38- permalinks for easy reference
39- links can be public or private
40- extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage)
41
42### Tag, view and search your links!
43- add a custom title and description to archived links
44- add tags to classify and search links
45 - features tag autocompletion, renaming, merging and deletion
46- full-text and tag search
47
48### Easy setup
49- dead-simple installation: drop the files, open the page
50- links are stored in a file
51 - compact storage
52 - no database required
53 - easy backup: simply copy the datastore file
54- import and export links as Netscape bookmarks
55
56### Accessibility
57- Firefox bookmarlet to share links in one click
58- support for mobile browsers
59- works with Javascript disabled
60- easy page customization through HTML/CSS/RainTPL
61
62### Security
63- bruteforce-proof login form
64- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
65and session cookie hijacking
66
67### Goodies
68- thumbnail generation for images and video services:
69dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
70 - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
71- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
72- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
73- discreet pop-up notification when a new release is available
74
75### REST API
76
77Easily extensible by any client using the REST API exposed by Shaarli.
78
79See the [API documentation](http://shaarli.github.io/api-documentation/).
80
81### Other usages
82Though Shaarli is primarily a bookmarking application, it can serve other purposes
83(see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)):
84- micro-blogging
85- pastebin
86- online notepad
87- snippet archive
88
89## About
90### Shaarli community fork
91This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
92
93This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
94
95The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191)
96that he would have no time to work on Shaarli in the near future.
97The Shaarli community has carried on the work to provide
98[many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master)
99for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
100in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
101
102### Contributing
103If you'd like to help, please:
104- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
105and [pull requests](https://github.com/shaarli/Shaarli/pulls)
106- feel free to report bugs (feedback is much appreciated)
107- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
108- propose solutions to existing problems
109- submit pull requests :-)
110
111
112### License
113Shaarli 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.
114