From 4ada0d313a37f12ef407060d5774e9f623c4abbd Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sat, 9 Dec 2017 15:20:14 +0100 Subject: move features.md info to index.md Ref https://github.com/shaarli/Shaarli/issues/598 --- doc/md/index.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) (limited to 'doc/md') 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 ## Features +Shaarli can be used: + +- to share, comment and save interesting links and news. +- to bookmark useful/frequent personal links (as private links) and share them between computers. +- as a minimal blog/microblog/writing platform (no character limit). +- as a read-it-later list (for example items tagged `readlater`). +- to draft and save articles/posts/ideas. +- to keep code snippets. +- to keep notes and documentation. +- as a shared clipboard/notepad/pastebin between machines. +- as a todo list. +- to store playlists (e.g. with the `music` or `video` tags). +- to keep extracts/comments from webpages that may disappear. +- to keep track of ongoing discussions (for example items tagged `discussion`). +- [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags. +- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...). + ### Interface - minimalist design (simple is beautiful) - FAST @@ -89,14 +106,12 @@ Easily extensible by any client using the REST API exposed by Shaarli. See the [API documentation](http://shaarli.github.io/api-documentation/). -### Other usages -Though Shaarli is primarily a bookmarking application, it can serve other purposes -(see [Features](Features)): - -- micro-blogging -- pastebin -- online notepad -- snippet archive +### Using Shaarli as a blog, notepad, pastebin... +- Go to your Shaarli setup and log in +- Click the `Add Link` button +- To share text only, do not enter any URL in the corresponding input field and click `Add Link` +- Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` +- VoilĂ ! Your article is now published (privately if you selected that option) and accessible using its permalink. ## About ### Shaarli community fork -- cgit v1.2.3