Rewrite README.md
Modifications: - group content in sections - homogenize formatting - replace installation instructions by links to the corresponding wiki pages - update badges - use http://shields.io/ to generate SVGs with custom labels - master branch: update Travis label - stable branch: add Travis status - GitHub release: display the latest released version Signed-off-by: VirtualTam <virtualtam@flibidi.net>
This commit is contained in:
VirtualTam
parent
bb91a8c6e8
commit
e9b80e7272
1 changed files with 94 additions and 69 deletions
163
README.md
163
README.md
|
|
@ -1,89 +1,114 @@
|
|||
|
||||
|
||||
Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
|
||||
The personal, minimalist, super-fast, no-database delicious clone.
|
||||
|
||||
Do 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 delicious clone that you can install on your own server._
|
||||
_It is designed to be personal (single-user), fast and handy._
|
||||
|
||||
[](https://gitter.im/shaarli/Shaarli)
|
||||
[](https://www.bountysource.com/teams/shaarli/issues) [](https://travis-ci.org/shaarli/Shaarli)
|
||||
[](https://travis-ci.org/shaarli/Shaarli)
|
||||
[](https://travis-ci.org/shaarli/Shaarli)
|
||||
[](https://github.com/shaarli/Shaarli/releases/latest/)
|
||||
[](https://hub.docker.com/r/shaarli/shaarli/)
|
||||
|
||||
[](https://gitter.im/shaarli/Shaarli)
|
||||
[](https://www.bountysource.com/teams/shaarli/issues)
|
||||
|
||||
## Quickstart
|
||||
- [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)
|
||||
- [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
|
||||
|
||||
### Demo
|
||||
You can use this [public demo instance of Shaarli](http://shaarlidemo.tuxfamily.org/Shaarli).
|
||||
It runs the latest development version of Shaarli and is updated/reset daily.
|
||||
|
||||
Login: `demo`; Password: `demo`
|
||||
|
||||
### Installation & upgrade
|
||||
- [Download](https://github.com/shaarli/Shaarli/wiki/Download)
|
||||
- [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements)
|
||||
- [Server configuration](https://github.com/shaarli/Shaarli/wiki/Server-configuration)
|
||||
- [Shaarli configuration](https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration)
|
||||
|
||||
## Features
|
||||
### Interface
|
||||
- minimalist design (simple is beautiful)
|
||||
- FAST
|
||||
- ATOM and RSS feeds
|
||||
- views:
|
||||
- paginated link list
|
||||
- tag cloud
|
||||
- picture wall: image and video thumbails
|
||||
- daily: newspaper-like daily digest
|
||||
- daily RSS feed
|
||||
- permalinks for easy reference
|
||||
- links can be public or private
|
||||
|
||||
* 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 (**bookmarklet**)
|
||||
* Save **URL, title, description** (unlimited size).
|
||||
* Classify, search and filter links with **tags**.
|
||||
* Tag autocompletion, renaming, merging and deletion.
|
||||
* Save links as **public or private**
|
||||
* Browse links by page, filter by tag or use the **full text search engine**
|
||||
* **Tag cloud**
|
||||
* **Picture wall** (which can be filtered by tag or text search)
|
||||
* **“Daily”** Newspaper-like digest, browsable by day.
|
||||
* **Permalinks** (with QR-Code) for easy reference
|
||||
* **RSS** and ATOM feeds
|
||||
* Can be filtered by tag or text search!
|
||||
* “Daily” RSS feed: Get each day a digest of all new links.
|
||||
* Can **import/export** Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…)
|
||||
* Automatic **image/video thumbnails** for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…)
|
||||
* Support for http/ftp/file/apt/magnet protocol links
|
||||
* URLs in descriptions are automatically converted to clickable links in descriptions
|
||||
* Easy backup (Data stored in a single file)
|
||||
* 1-click access to your private links/notes
|
||||
* Compact storage (1315 links stored in 150 kb)
|
||||
* Mobile browsers support
|
||||
* Also works with javascript disabled
|
||||
* Brute force protected login form
|
||||
* [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
|
||||
* Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…)
|
||||
* Pages are easy to customize (using CSS and simple RainTPL templates)
|
||||
* Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery), session cookie hijacking.
|
||||
* You will be automatically notified by a discreet popup if a new version is available
|
||||
* **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)**
|
||||
### Tag, view and search your links!
|
||||
- add a custom title and description to archived links
|
||||
- add tags to classify and search links
|
||||
- features tag autocompletion, renaming, merging and deletion
|
||||
- full-text and tag search
|
||||
|
||||
## Demo
|
||||
You 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.
|
||||
### Easy setup
|
||||
- dead-simple installation: drop the files, open the page
|
||||
- links are stored in a file
|
||||
- compact storage
|
||||
- no database required
|
||||
- easy backup: simply copy the datastore file
|
||||
- import and export links as Netscape bookmarks
|
||||
|
||||
Login: `demo`
|
||||
Password: `demo`
|
||||
### Accessibility
|
||||
- Firefox bookmarlet to share links in one click
|
||||
- support for mobile browsers
|
||||
- works with Javascript disabled
|
||||
- easy page customization through HTML/CSS/RainTPL
|
||||
|
||||
### Security
|
||||
- bruteforce-proof login form
|
||||
- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
|
||||
and session cookie hijacking
|
||||
|
||||
## Links
|
||||
|
||||
* **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)**
|
||||
* [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
|
||||
|
||||
|
||||
## Requirements
|
||||
|
||||
Check the [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements) wiki page.
|
||||
|
||||
## Installing
|
||||
|
||||
* Download the latest stable release from https://github.com/shaarli/Shaarli/releases
|
||||
* Unpack the archive in a directory on your web server
|
||||
* Visit this directory from a web browser.
|
||||
* Choose login, password, timezone and page title. Save.
|
||||
|
||||
_To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_
|
||||
|
||||
|
||||
## Upgrading
|
||||
|
||||
* **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.
|
||||
* **If you installed using `git clone`**: run `git pull` in your Shaarli directory.
|
||||
### Goodies
|
||||
- thumbnail generation for images and video services:
|
||||
dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
|
||||
- lazy-loading with [bLazy](http://dinbror.dk/blazy/)
|
||||
- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
|
||||
- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
|
||||
- discreet pop-up notification when a new release is available
|
||||
|
||||
### Other usages
|
||||
Though Shaarli is primarily a bookmarking application, it can serve other purposes
|
||||
(see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)):
|
||||
- micro-blogging
|
||||
- pastebin
|
||||
- online notepad
|
||||
- snippet archive
|
||||
|
||||
## About
|
||||
### Shaarli community fork
|
||||
This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
|
||||
|
||||
This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli
|
||||
This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
|
||||
|
||||
This 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.
|
||||
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.
|
||||
|
||||
### Contributing
|
||||
If you'd like to help, please:
|
||||
- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
|
||||
and [pull requests](https://github.com/shaarli/Shaarli/pulls)
|
||||
- feel free to report bugs (feedback is much appreciated)
|
||||
- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki)
|
||||
- propose solutions to existing problems
|
||||
- submit pull requests :-)
|
||||
|
||||
|
||||
## License
|
||||
|
||||
### License
|
||||
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.
|
||||
|
|
|
|||
Loading…
Reference in a new issue