[github/shaarli/Shaarli.git] / doc / md / Features.md

### Main features
Shaarli is intended:

- 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/ideas
- to keep code snippets
- to keep notes and documentation
- as a shared clipboard 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 ...)

### 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.
Commit	Line	Data
992af0b9 V	1	### Main features
992af0b9 V	2	Shaarli is intended:
43ad7c8e V	3
	4	- to share, comment and save interesting links and news
	5	- to bookmark useful/frequent personal links (as private links) and share them between computers
	6	- as a minimal blog/microblog/writing platform (no character limit)
	7	- as a read-it-later list (for example items tagged `readlater`)
	8	- to draft and save articles/ideas
	9	- to keep code snippets
	10	- to keep notes and documentation
	11	- as a shared clipboard between machines
	12	- as a todo list
	13	- to store playlists (e.g. with the `music` or `video` tags)
	14	- to keep extracts/comments from webpages that may disappear
	15	- to keep track of ongoing discussions (for example items tagged `discussion`)
	16	- [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags
	17	- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)
992af0b9 V	18
	19	### Using Shaarli as a blog, notepad, pastebin...
	20
43ad7c8e V	21	- Go to your Shaarli setup and log in
	22	- Click the `Add Link` button
	23	- To share text only, do not enter any URL in the corresponding input field and click `Add Link`
	24	- Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save`
	25	- Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink.