aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorVirtualTam <virtualtam@flibidi.net>2015-09-06 02:16:39 +0200
committerVirtualTam <virtualtam@flibidi.net>2015-09-06 02:16:39 +0200
commit6f2309aa08b50e770096e334f05fe2ba2d9a8e51 (patch)
tree0b4865ff531491d0bd241d99e62d68c00ad86ba1 /README.md
parentbb91a8c6e8649d482a552b64c6a0c8e65c6becd7 (diff)
parente9b80e72729c3fb984f7b2f3d9603c3b3fcd1849 (diff)
downloadShaarli-6f2309aa08b50e770096e334f05fe2ba2d9a8e51.tar.gz
Shaarli-6f2309aa08b50e770096e334f05fe2ba2d9a8e51.tar.zst
Shaarli-6f2309aa08b50e770096e334f05fe2ba2d9a8e51.zip
Merge pull request #343 from virtualtam/readme
Rewrite README.md
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md175
1 files changed, 100 insertions, 75 deletions
diff --git a/README.md b/README.md
index a5a3bba1..9cc4773b 100755
--- a/README.md
+++ b/README.md
@@ -1,89 +1,114 @@
1![Shaarli logo](doc/images/doc-logo.png) 1![Shaarli logo](doc/images/doc-logo.png)
2 2
3Shaarli, the personal, minimalist, super-fast, no-database delicious clone. 3The personal, minimalist, super-fast, no-database delicious clone.
4 4
5Do you want to share the links you discover? Shaarli is a minimalist delicious clone you can install on your own website. 5_Do you want to share the links you discover?_
6It is designed to be personal (single-user), fast and handy. 6_Shaarli is a minimalist delicious clone that you can install on your own server._
7_It is designed to be personal (single-user), fast and handy._
7 8
8[![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli) 9[![](https://img.shields.io/travis/shaarli/Shaarli.svg?label=master)](https://travis-ci.org/shaarli/Shaarli)
9[![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues) [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](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/)
10[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) 12[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
11 13
12## Features 14[![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli)
13 15[![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues)
14 * Minimalist design (simple is beautiful)
15 * **FAST**
16 * Dead-simple installation: Drop the files, open the page. No database required.
17 * Easy to use: Single button in your browser to bookmark a page (**bookmarklet**)
18 * Save **URL, title, description** (unlimited size).
19 * Classify, search and filter links with **tags**.
20 * Tag autocompletion, renaming, merging and deletion.
21 * Save links as **public or private**
22 * Browse links by page, filter by tag or use the **full text search engine**
23 * **Tag cloud**
24 * **Picture wall** (which can be filtered by tag or text search)
25 * **“Daily”** Newspaper-like digest, browsable by day.
26 * **Permalinks** (with QR-Code) for easy reference
27 * **RSS** and ATOM feeds
28 * Can be filtered by tag or text search!
29 * “Daily” RSS feed: Get each day a digest of all new links.
30 * Can **import/export** Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…)
31 * Automatic **image/video thumbnails** for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…)
32 * Support for http/ftp/file/apt/magnet protocol links
33 * URLs in descriptions are automatically converted to clickable links in descriptions
34 * Easy backup (Data stored in a single file)
35 * 1-click access to your private links/notes
36 * Compact storage (1315 links stored in 150 kb)
37 * Mobile browsers support
38 * Also works with javascript disabled
39 * Brute force protected login form
40 * [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
41 * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…)
42 * Pages are easy to customize (using CSS and simple RainTPL templates)
43 * Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery), session cookie hijacking.
44 * You will be automatically notified by a discreet popup if a new version is available
45 * **Shaarli is a bookmarking application, but you can use it for micro-blogging (like Twitter), a pastebin, an online notepad, a snippet repository, etc. See [Usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)**
46
47## Demo
48You can use this [public demo instance of Shaarli](http://shaarlidemo.tuxfamily.org/Shaarli). This demo runs the latest _development version_ of Shaarli and is updated/reset every day.
49
50Login: `demo`
51Password: `demo`
52
53
54## Links
55
56 * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)**
57 * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
58
59
60## Requirements
61
62Check the [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements) wiki page.
63
64## Installing
65
66 * Download the latest stable release from https://github.com/shaarli/Shaarli/releases
67 * Unpack the archive in a directory on your web server
68 * Visit this directory from a web browser.
69 * Choose login, password, timezone and page title. Save.
70 16
71_To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_ 17## Quickstart
18- [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)
19- [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
72 20
21### Demo
22You can use this [public demo instance of Shaarli](http://shaarlidemo.tuxfamily.org/Shaarli).
23It runs the latest development version of Shaarli and is updated/reset daily.
73 24
74## Upgrading 25Login: `demo`; Password: `demo`
75 26
76 * **If you installed from the zip:** Delete all files and directories except the `data` directory, then unzip the new version of Shaarli. You will not lose your links and you will not have to reconfigure it. 27### Installation & upgrade
77 * **If you installed using `git clone`**: run `git pull` in your Shaarli directory. 28- [Download](https://github.com/shaarli/Shaarli/wiki/Download)
29- [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements)
30- [Server configuration](https://github.com/shaarli/Shaarli/wiki/Server-configuration)
31- [Shaarli configuration](https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration)
78 32
33## Features
34### Interface
35- minimalist design (simple is beautiful)
36- FAST
37- ATOM and RSS feeds
38- views:
39 - paginated link list
40 - tag cloud
41 - picture wall: image and video thumbails
42 - daily: newspaper-like daily digest
43 - daily RSS feed
44- permalinks for easy reference
45- links can be public or private
46
47### Tag, view and search your links!
48- add a custom title and description to archived links
49- add tags to classify and search links
50 - features tag autocompletion, renaming, merging and deletion
51- full-text and tag search
52
53### Easy setup
54- dead-simple installation: drop the files, open the page
55- links are stored in a file
56 - compact storage
57 - no database required
58 - easy backup: simply copy the datastore file
59- import and export links as Netscape bookmarks
60
61### Accessibility
62- Firefox bookmarlet to share links in one click
63- support for mobile browsers
64- works with Javascript disabled
65- easy page customization through HTML/CSS/RainTPL
66
67### Security
68- bruteforce-proof login form
69- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
70and session cookie hijacking
71
72### Goodies
73- thumbnail generation for images and video services:
74dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
75 - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
76- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
77- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
78- discreet pop-up notification when a new release is available
79
80### Other usages
81Though Shaarli is primarily a bookmarking application, it can serve other purposes
82(see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)):
83- micro-blogging
84- pastebin
85- online notepad
86- snippet archive
79 87
80## About 88## About
81 89### Shaarli community fork
82This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli 90This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
83 91
84This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [sebsauvage](http://sebsauvage.net/). The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) that he would have no time to work on Shaarli in the near future. The Shaarli community has carried on the work to provide [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. If you'd like to help, have a look at the current [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls) and feel free to report bugs and feature requests, propose solutions to existing problems and send us pull requests. 92This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
85 93
86 94The original project is currently unmaintained, and the developer
87## License 95[has informed us](https://github.com/sebsauvage/Shaarli/issues/191) that he would
88 96have 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,
101while keeping Shaarli simple and efficient.
102
103### Contributing
104If you'd like to help, please:
105- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
106and [pull requests](https://github.com/shaarli/Shaarli/pulls)
107- feel free to report bugs (feedback is much appreciated)
108- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
109- propose solutions to existing problems
110- submit pull requests :-)
111
112
113### License
89Shaarli 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. 114Shaarli 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.