1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/yourls_ynh.git synced 2024-09-03 20:35:59 +02:00
yourls_ynh/sources/README.md
2014-06-13 07:30:00 +02:00

40 lines
1.8 KiB
Markdown

![yourls](images/yourls-logo.png)
[YOURLS](http://yourls.org) — [![Build Status](https://travis-ci.org/YOURLS/YOURLS.png?branch=master)](https://travis-ci.org/YOURLS/YOURLS)
========
**YOURLS** is a set of PHP scripts that will allow you to run Your Own URL Shortener. You'll have full control over your data, detailed stats and analytics, plugins, and more. It's free.
Quick Start
-----------
To get started, check [yourls.org](http://yourls.org)!
Learn more tweaks in the [Wiki documentation](https://github.com/YOURLS/YOURLS/wiki/).
News
----
Keep track of development and community news.
* Follow [@yourls on Twitter](http://twitter.com/yourls).
* Read and subscribe to the [The Official YOURLS Blog](http://blog.yourls.org).
* Check [commit messages](https://github.com/YOURLS/YOURLS/commits/master).
Versioning
----------
For transparency and insight into our release cycle, and for striving to maintain backward compatibility, YOURLS will be maintained under the [Semantic Versioning](http://semver.org) guidelines as much as possible.
Releases will be numbered with the following format: `<major>.<minor>.<patch>`
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch
*[Release Archive](https://github.com/YOURLS/YOURLS/releases)*
Bug Tracker
-----------
Have a bug or a feature request? [Please open a new issue](https://github.com/YOURLS/YOURLS/issues).
__Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/YOURLS/YOURLS/wiki/Bug-Report).__
License
-------
Free software. Do whatever the hell you want with it.
The [license](LICENSE.md) under which YOURLS is released is the MIT license.