X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2Findex.md;h=e77b4d3a18c59468663fbfbc0c783fb677222f03;hb=ebc7ec7c1cc858943427b74add6fc609f234c2bb;hp=5f10227f5b45c78006e6859cff42efce0b4fcee0;hpb=02ff7897c0bcb48521ddd0c494f346b6df275ab4;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/index.md b/doc/md/index.md index 5f10227f..e77b4d3a 100644 --- a/doc/md/index.md +++ b/doc/md/index.md @@ -22,21 +22,25 @@ It runs the latest development version of Shaarli and is updated/reset daily. Login: `demo`; Password: `demo` -Docker users can start a personal instance from an [autobuild image](https://hub.docker.com/r/shaarli/shaarli/). For an example to start a temporary Shaarli at ``localhost:8000``, and to keeps the data you create (config, storage) during the session: -``` -MY_SHAARLI_VOLUME=$(cd /path/to/shaarli/data/ && pwd -P) -docker run -ti --rm \ - -p 8000:80 \ - -v $MY_SHAARLI_VOLUME:/var/www/shaarli/data \ - shaarli/shaarli -``` - -A brief guide on getting starting using docker is given in [Docker 101](docker/docker-101). - -To learn more about user data and how to keep it across versions, please see [Upgrade and Migration](Upgrade-and-migration) documentation. - ## 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 @@ -90,14 +94,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