diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 89 |
1 files changed, 47 insertions, 42 deletions
| @@ -1,71 +1,76 @@ | |||
| 1 |  | 1 |  |
| 2 | 2 | ||
| 3 | Shaarli, the personal, minimalist, super-fast, no-database delicious clone. | 3 | Shaarli, the personal, minimalist, super-fast, no-database delicious clone. |
| 4 | 4 | ||
| 5 | You want to share the links you discover ? Shaarli is a minimalist delicious clone you can install on your own website. | 5 | You want to share the links you discover ? Shaarli is a minimalist delicious clone you can install on your own website. |
| 6 | It is designed to be personal (single-user), fast and handy. | 6 | It is designed to be personal (single-user), fast and handy. |
| 7 | 7 | ||
| 8 | 8 | ||
| 9 | Features: | 9 | ## Features: |
| 10 | 10 | ||
| 11 | * Minimalist design (simple is beautiful) | 11 | * Minimalist design (simple is beautiful) |
| 12 | * **FAST** | 12 | * **FAST** |
| 13 | * Dead-simple installation: Drop the files, open the page. No database required. | 13 | * Dead-simple installation: Drop the files, open the page. No database required. |
| 14 | * Easy to use: Single button in your browser to bookmark a page | 14 | * Easy to use: Single button in your browser to bookmark a page (**bookmarklet**) |
| 15 | * Save url, title, description (unlimited size). Classify links with tags (with autocomplete) | 15 | * Save **URL, title, description** (unlimited size). |
| 16 | * Tag renaming, merging and deletion. | 16 | * Classify, search and filter links with **tags**. |
| 17 | * Automatic thumbnails for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…) | 17 | * Tag autocompletion, renaming, merging and deletion. |
| 18 | * Automatic conversion of URLs to clickable links in descriptions. Support for http/ftp/file/apt/magnet protocols. | 18 | * Save links as **public or private** |
| 19 | * Save links as public or private | 19 | * Browse links by page, filter by tag or use the **full text search engine** |
| 20 | * 1-clic access to your private links/notes | 20 | * **Tag cloud** |
| 21 | * Browse links by page, filter by tag or use the full text search engine | 21 | * **Picture wall** (which can be filtered by tag or text search) |
| 22 | * Permalinks (with QR-Code) for easy reference | 22 | * **“Daily”** Newspaper-like digest, browsable by day. |
| 23 | * RSS and ATOM feeds (which can be filtered by tag or text search) | 23 | * **Permalinks** (with QR-Code) for easy reference |
| 24 | * Tag cloud | 24 | * **RSS** and ATOM feeds |
| 25 | * Picture wall (which can be filtered by tag or text search) | 25 | * Can be filtered by tag or text search! |
| 26 | * “Links of the day” Newspaper-like digest, browsable by day. | 26 | * “Daily” RSS feed: Get each day a digest of all new links. |
| 27 | * “Daily” RSS feed: Get each day a digest of all new links. | 27 | * Can **import/export** Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…) |
| 28 | * [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support | 28 | * Automatic **image/video thumbnails** for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…) |
| 29 | * Support for http/ftp/file/apt/magnet protocol links | ||
| 30 | * URLs in descriptions are automatically converted to clickable links in descriptions | ||
| 29 | * Easy backup (Data stored in a single file) | 31 | * Easy backup (Data stored in a single file) |
| 32 | * 1-click access to your private links/notes | ||
| 30 | * Compact storage (1315 links stored in 150 kb) | 33 | * Compact storage (1315 links stored in 150 kb) |
| 31 | * Mobile browsers support | 34 | * Mobile browsers support |
| 32 | * Also works with javascript disabled | 35 | * Also works with javascript disabled |
| 33 | * Can import/export Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…) | ||
| 34 | * Brute force protected login form | 36 | * Brute force protected login form |
| 35 | * Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery), session cookie hijacking. | 37 | * [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support |
| 36 | * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…) | 38 | * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…) |
| 37 | * Shaarli is a bookmarking application, but you can use it for micro-blogging (like Twitter), a pastebin, an online notepad, a snippet repository, etc. | ||
| 38 | * You will be automatically notified by a discreet popup if a new version is available | ||
| 39 | * Pages are easy to customize (using CSS and simple RainTPL templates) | 39 | * Pages are easy to customize (using CSS and simple RainTPL templates) |
| 40 | * Protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery), session cookie hijacking. | ||
| 41 | * You will be automatically notified by a discreet popup if a new version is available | ||
| 42 | * **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)** | ||
| 43 | |||
| 44 | ## Links | ||
| 45 | * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)** | ||
| 46 | * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) | ||
| 47 | |||
| 40 | 48 | ||
| 49 | ## Installing | ||
| 50 | Shaarli requires php 5.1 | ||
| 41 | 51 | ||
| 42 | Requires php 5.1 | 52 | * Download the latest stable release from https://github.com/shaarli/Shaarli/releases |
| 53 | * Unpack the archive in a directory on your web server | ||
| 54 | * Visit this directory from a web browser. | ||
| 55 | * Choose login, password, timezone and page title. Save. | ||
| 43 | 56 | ||
| 44 | More information on the project page: | 57 | _To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_ |
| 45 | http://sebsauvage.net/wiki/doku.php?id=php:shaarli | ||
| 46 | 58 | ||
| 47 | ------------------------------------------------------------------------------ | 59 | ## Upgrading |
| 60 | Delete all files and directories except the `data` directory, then unzip the new version of Shaarli. | ||
| 61 | You will not lose your links and you will not have to reconfigure it. | ||
| 48 | 62 | ||
| 49 | Shaarli is distributed under the zlib/libpng License: | ||
| 50 | 63 | ||
| 51 | Copyright (c) 2011 Sébastien SAUVAGE (sebsauvage.net) | 64 | ## Screenshots |
| 52 | 65 | ||
| 53 | This software is provided 'as-is', without any express or implied warranty. | 66 | [](https://cdn.mediacru.sh/kE8SyD-PvGuC.png) [](https://cdn.mediacru.sh/iqTvO1-yP9pU.png) [](https://cdn.mediacru.sh/mMoi31f94wdL.png) [](https://cdn.mediacru.sh/GcoZPZmCZ-DR.png) [](https://cdn.mediacru.sh/TDDujpMWT31q.png) |
| 54 | In no event will the authors be held liable for any damages arising from | ||
| 55 | the use of this software. | ||
| 56 | 67 | ||
| 57 | Permission is granted to anyone to use this software for any purpose, | 68 | ## About |
| 58 | including commercial applications, and to alter it and redistribute it | ||
| 59 | freely, subject to the following restrictions: | ||
| 60 | 69 | ||
| 61 | 1. The origin of this software must not be misrepresented; you must not | 70 | Original Project page: http://sebsauvage.net/wiki/doku.php?id=php:shaarli |
| 62 | claim that you wrote the original software. If you use this software | 71 | Shaarli is developed by [Sébastien SAUVAGE](http://sebsauvage.net) and [contributors](COPYING). |
| 63 | in a product, an acknowledgment in the product documentation would | ||
| 64 | be appreciated but is not required. | ||
| 65 | 72 | ||
| 66 | 2. Altered source versions must be plainly marked as such, and must | 73 | Shaarli is [Free Software](https://en.wikipedia.org/wiki/Free_software) distributed under the [zlib/libpng License](http://www.gzip.org/zlib/zlib_license.html) |
| 67 | not be misrepresented as being the original software. | ||
| 68 | 74 | ||
| 69 | 3. This notice may not be removed or altered from any source distribution. | 75 | This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli |
| 70 | 76 | ||
| 71 | ------------------------------------------------------------------------------ | ||