<p>If you have any questions or ideas, please join the <ahref="https://gitter.im/shaarli/Shaarli">chat</a> (also reachable via <ahref="https://irc.gitter.im/">IRC</a>), post them in our <ahref="https://github.com/shaarli/Shaarli/issues/308">general discussion</a> or read the current <ahref="https://github.com/shaarli/Shaarli/issues">issues</a>.
If you've found a bug, please create a <ahref="https://github.com/shaarli/Shaarli/issues/new">new issue</a>.</p>
<p>If you would like a feature added to Shaarli, check the issues labeled <ahref="https://github.com/shaarli/Shaarli/labels/feature"><code>feature</code></a>, <ahref="https://github.com/shaarli/Shaarli/labels/enhancement"><code>enhancement</code></a>, and <ahref="https://github.com/shaarli/Shaarli/labels/plugin"><code>plugin</code></a>.</p>
<p><em>Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the <code>doc/html/</code> directory of your Shaarli installation.</em></p>
<p><ahref="https://gitter.im/shaarli/Shaarli"><imgalt="Join the chat at https://gitter.im/shaarli/Shaarli"src="https://badges.gitter.im/Join%20Chat.svg"/></a>
<li>URL cleanup: automatic removal of <code>?utm_source=...</code>, <code>fb=...</code></li>
<li>discreet pop-up notification when a new release is available</li>
</ul>
<h3id="rest-api">REST API</h3>
<p>Easily extensible by any client using the REST API exposed by Shaarli.</p>
<p>See the <ahref="http://shaarli.github.io/api-documentation/">API documentation</a>.</p>
<h3id="other-usages">Other usages</h3>
<p>Though Shaarli is primarily a bookmarking application, it can serve other purposes
(see <ahref="https://github.com/shaarli/Shaarli/wiki#usage-examples">usage examples</a>):
- micro-blogging
- pastebin
- online notepad
- snippet archive</p>
<h2id="about">About</h2>
<h3id="shaarli-community-fork">Shaarli community fork</h3>
<p>This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli</p>
<p>This is a community fork of the original <ahref="https://github.com/sebsauvage/Shaarli/">Shaarli</a> project by <ahref="http://sebsauvage.net/">Sébastien Sauvage</a>.</p>
<p>The original project is currently unmaintained, and the developer <ahref="https://github.com/sebsauvage/Shaarli/issues/191">has informed us</a>
that he would have no time to work on Shaarli in the near future.
The Shaarli community has carried on the work to provide
for <ahref="https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+">bug fixes and enhancements</a>
in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.</p>
<h3id="contributing">Contributing</h3>
<p>If you'd like to help, please:
- have a look at the open <ahref="https://github.com/shaarli/Shaarli/issues">issues</a>
and <ahref="https://github.com/shaarli/Shaarli/pulls">pull requests</a>
- feel free to report bugs (feedback is much appreciated)
- suggest new features and improvements to both code and <ahref="https://github.com/shaarli/Shaarli/wiki">documentation</a>
- propose solutions to existing problems
- submit pull requests :-)</p>
<h3id="license">License</h3>
<p>Shaarli is <ahref="http://en.wikipedia.org/wiki/Free_software">Free Software</a>. See <ahref="./COPYING">COPYING</a> for a detail of the contributors and licenses for each individual component.</p>
<ahref="Download-and-Installation/"class="btn btn-neutral float-right"title="Download and Installation">Next <spanclass="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<divrole="contentinfo">
<!-- Copyright etc -->
</div>
Built with <ahref="http://www.mkdocs.org">MkDocs</a> using a <ahref="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
