README.md

   1 ![yourls](images/yourls-logo.png)
   2 [YOURLS](http://yourls.org) — [![Build Status](https://travis-ci.org/YOURLS/YOURLS.png?branch=master)](https://travis-ci.org/YOURLS/YOURLS)
   3 ========
   4 **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.
   5
   6 Quick Start
   7 -----------
   8 To get started, check [yourls.org](http://yourls.org)!
   9 Learn more tweaks in the [Wiki documentation](https://github.com/YOURLS/YOURLS/wiki/).
  10
  11 News
  12 ----
  13 Keep track of development and community news.
  14
  15 * Follow [@yourls on Twitter](http://twitter.com/yourls).
  16 * Read and subscribe to the [The Official YOURLS Blog](http://blog.yourls.org).
  17 * Check [commit messages](https://github.com/YOURLS/YOURLS/commits/master).
  18
  19 Versioning
  20 ----------
  21 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.
  22
  23 Releases will be numbered with the following format: `<major>.<minor>.<patch>`
  24
  25 And constructed with the following guidelines:
  26 * Breaking backward compatibility bumps the major (and resets the minor and patch)
  27 * New additions without breaking backward compatibility bumps the minor (and resets the patch)
  28 * Bug fixes and misc changes bumps the patch
  29
  30 *[Release Archive](https://github.com/YOURLS/YOURLS/releases)*
  31
  32 Bug Tracker
  33 -----------
  34 Have a bug or a feature request? [Please open a new issue](https://github.com/YOURLS/YOURLS/issues).
  35 __Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/YOURLS/YOURLS/wiki/Bug-Report).__
  36
  37 License
  38 -------
  39 Free software. Do whatever the hell you want with it.
  40 The [license](LICENSE.md) under which YOURLS is released is the MIT license.