diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..3d42ead2 --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,69 @@ | |||
1 | Shaarli 0.0.40 beta | ||
2 | The personal, minimalist, super-fast, no-database delicious clone. | ||
3 | |||
4 | You want to share the links you discover ? Shaarli is a minimalist delicious clone you can install on your own website. | ||
5 | It is designed to be personal (single-user), fast and handy. | ||
6 | |||
7 | |||
8 | Features: | ||
9 | |||
10 | * Minimalist design (simple is beautiful) | ||
11 | * FAST | ||
12 | * Dead-simple installation: Drop the files, open the page. No database required. | ||
13 | * Easy to use: Single button in your browser to bookmark a page | ||
14 | * Save url, title, description (unlimited size). Classify links with tags (with autocomplete) | ||
15 | * Tag renaming, merging and deletion. | ||
16 | * Automatic thumbnails for various services (imgur, imageshack.us, flickr, youtube, vimeo, dailymotion…) | ||
17 | * Automatic conversion of URLs to clickable links in descriptions. Support for http/ftp/file/apt protocols. | ||
18 | * Save links as public or private | ||
19 | * 1-clic access to your private links/notes | ||
20 | * Browse links by page, filter by tag or use the full text search engine | ||
21 | * Permalinks (with QR-Code) for easy reference | ||
22 | * Tag cloud | ||
23 | * Picture wall (which can be filtered by tag or text search) | ||
24 | * “Links of the day” Newspaper-like digest, browsable by day. | ||
25 | * “Daily” RSS feed: Get each day a digest of all new links. | ||
26 | * RSS and ATOM feeds (which can be filtered by tag or text search) | ||
27 | * PubSubHubbub protocol support | ||
28 | * Easy backup (Data stored in a single file) | ||
29 | * Compact storage (1315 links stored in 150 kb) | ||
30 | * Mobile browsers support | ||
31 | * Can import/export Netscape bookmarks (for import/export from/to Firefox, Opera, Chrome, Delicious…) | ||
32 | * Automatic ban of IP address upon too many failed logins | ||
33 | * Protected against XSRF, session cookie hijacking. | ||
34 | * Automatic removal of annoying FeedBurner/Google FeedProxy parameters in URL (?utm_source…) | ||
35 | * Shaarli is a bookmarking application, but you can use it for micro-blogging (like Twitter), a pastebin, an online notepad, a snippet repository, etc. | ||
36 | * You will be automatically notified by a discreet popup if a new version is available | ||
37 | * Pages are easy to customize (using simple RainTPL templates) | ||
38 | |||
39 | |||
40 | Requires php 5.1 (php 5.2 required for autocomplete.) | ||
41 | |||
42 | More information on the project page: | ||
43 | http://sebsauvage.net/wiki/doku.php?id=php:shaarli | ||
44 | |||
45 | ------------------------------------------------------------------------------ | ||
46 | |||
47 | Shaarli is distributed under the zlib/libpng License: | ||
48 | |||
49 | Copyright (c) 2011 Sébastien SAUVAGE (sebsauvage.net) | ||
50 | |||
51 | This software is provided 'as-is', without any express or implied warranty. | ||
52 | In no event will the authors be held liable for any damages arising from | ||
53 | the use of this software. | ||
54 | |||
55 | Permission is granted to anyone to use this software for any purpose, | ||
56 | including commercial applications, and to alter it and redistribute it | ||
57 | freely, subject to the following restrictions: | ||
58 | |||
59 | 1. The origin of this software must not be misrepresented; you must not | ||
60 | claim that you wrote the original software. If you use this software | ||
61 | in a product, an acknowledgment in the product documentation would | ||
62 | be appreciated but is not required. | ||
63 | |||
64 | 2. Altered source versions must be plainly marked as such, and must | ||
65 | not be misrepresented as being the original software. | ||
66 | |||
67 | 3. This notice may not be removed or altered from any source distribution. | ||
68 | |||
69 | ------------------------------------------------------------------------------ | ||