diff options
| author | nodiscc <nodiscc@gmail.com> | 2017-12-09 15:20:14 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-09 15:20:14 +0100 |
| commit | 4ada0d313a37f12ef407060d5774e9f623c4abbd (patch) | |
| tree | b92acc4766da57b96b0942a4a8ebebe8f7b7c87a | |
| parent | 288787917386d0f757bbdda66f5bee554951592e (diff) | |
| download | Shaarli-4ada0d313a37f12ef407060d5774e9f623c4abbd.tar.gz Shaarli-4ada0d313a37f12ef407060d5774e9f623c4abbd.tar.zst Shaarli-4ada0d313a37f12ef407060d5774e9f623c4abbd.zip | |
move features.md info to index.md
Ref https://github.com/shaarli/Shaarli/issues/598
| -rw-r--r-- | doc/md/index.md | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/doc/md/index.md b/doc/md/index.md index 2b7d0f00..1ffe6824 100644 --- a/doc/md/index.md +++ b/doc/md/index.md | |||
| @@ -36,6 +36,23 @@ To learn more about user data and how to keep it across versions, please see [Up | |||
| 36 | 36 | ||
| 37 | ## Features | 37 | ## Features |
| 38 | 38 | ||
| 39 | Shaarli can be used: | ||
| 40 | |||
| 41 | - to share, comment and save interesting links and news. | ||
| 42 | - to bookmark useful/frequent personal links (as private links) and share them between computers. | ||
| 43 | - as a minimal blog/microblog/writing platform (no character limit). | ||
| 44 | - as a read-it-later list (for example items tagged `readlater`). | ||
| 45 | - to draft and save articles/posts/ideas. | ||
| 46 | - to keep code snippets. | ||
| 47 | - to keep notes and documentation. | ||
| 48 | - as a shared clipboard/notepad/pastebin between machines. | ||
| 49 | - as a todo list. | ||
| 50 | - to store playlists (e.g. with the `music` or `video` tags). | ||
| 51 | - to keep extracts/comments from webpages that may disappear. | ||
| 52 | - to keep track of ongoing discussions (for example items tagged `discussion`). | ||
| 53 | - [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags. | ||
| 54 | - to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...). | ||
| 55 | |||
| 39 | ### Interface | 56 | ### Interface |
| 40 | - minimalist design (simple is beautiful) | 57 | - minimalist design (simple is beautiful) |
| 41 | - FAST | 58 | - FAST |
| @@ -89,14 +106,12 @@ Easily extensible by any client using the REST API exposed by Shaarli. | |||
| 89 | 106 | ||
| 90 | See the [API documentation](http://shaarli.github.io/api-documentation/). | 107 | See the [API documentation](http://shaarli.github.io/api-documentation/). |
| 91 | 108 | ||
| 92 | ### Other usages | 109 | ### Using Shaarli as a blog, notepad, pastebin... |
| 93 | Though Shaarli is primarily a bookmarking application, it can serve other purposes | 110 | - Go to your Shaarli setup and log in |
| 94 | (see [Features](Features)): | 111 | - Click the `Add Link` button |
| 95 | 112 | - To share text only, do not enter any URL in the corresponding input field and click `Add Link` | |
| 96 | - micro-blogging | 113 | - Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` |
| 97 | - pastebin | 114 | - Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. |
| 98 | - online notepad | ||
| 99 | - snippet archive | ||
| 100 | 115 | ||
| 101 | ## About | 116 | ## About |
| 102 | ### Shaarli community fork | 117 | ### Shaarli community fork |