README.md

   1 ![yourls](http://yourls.org/images/yourls-logo.png)
   2 [YOURLS](http://yourls.org)
   3 ======
   4 **YOURLS** is a set of PHP script 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 Useful links
   7 ------------
   8 * [Project home & doc](http://yourls.org)
   9 * [Wiki documentation](https://github.com/YOURLS/YOURLS/wiki/)
  10 * [Issue tracker](https://github.com/YOURLS/YOURLS/issues)
  11 * [Release archive](https://github.com/YOURLS/YOURLS/tags)
  12
  13 News
  14 ----
  15 Keep track of development and community news.
  16
  17 * Follow [@yourls on Twitter](http://twitter.com/yourls).
  18 * Read and subscribe to the [The Official YOURLS Blog](http://blog.yourls.org).
  19 * Check [commit messages](https://github.com/YOURLS/YOURLS/commits/master).
  20
  21 Versioning
  22 ----------
  23 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.
  24
  25 Releases will be numbered with the following format: `<major>.<minor>.<patch>`
  26
  27 And constructed with the following guidelines:
  28 * Breaking backward compatibility bumps the major (and resets the minor and patch)
  29 * New additions without breaking backward compatibility bumps the minor (and resets the patch)
  30 * Bug fixes and misc changes bumps the patch
  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.