README.md

   1 [![yourls](images/yourls-logo.png)](https://yourls.org) [![Build Status](https://travis-ci.org/YOURLS/YOURLS.png?branch=master)](https://travis-ci.org/YOURLS/YOURLS)
   2 ========
   3
   4 **YOURLS** is a set of PHP scripts that will allow you to run <strong>Y</strong>our <strong>O</strong>wn <strong>URL</strong> <strong>S</strong>hortener. You'll have full control over your data, detailed stats, analytics, plugins, and more. It's free.
   5
   6
   7 Quick Start
   8 -----------
   9 To get started, check [yourls.org](https://yourls.org)!
  10 Learn more tweaks in the [Wiki documentation](https://github.com/YOURLS/YOURLS/wiki/).
  11
  12
  13 Community news, tips and tricks
  14 -------------------------------
  15 * Read and subscribe to the [The Official YOURLS Blog](http://blog.yourls.org)
  16 * Follow [@yourls](https://twitter.com/yourls)
  17 * Subscribe to the [YOURLS User Newsletter](http://yourls.org/newsletter) (infrequent, low volume)
  18
  19
  20 Keep track of development
  21 -------------------------
  22 * Follow [@yourls_dev](http://twitter.com/yourls_dev)
  23 * Check [commit messages](https://github.com/YOURLS/YOURLS/commits/master)
  24 * Check the [Road map](https://github.com/YOURLS/YOURLS/wiki/Road-Map)
  25
  26
  27 Bug Tracker
  28 -----------
  29 __Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/YOURLS/YOURLS/wiki/Bug-Report).__
  30
  31 Have a **new bug** to report? [Please open a new issue](https://github.com/YOURLS/YOURLS/issues/new?title=Issue+title+--+be+DESCRIPTIVE).
  32
  33
  34 Versioning
  35 ----------
  36 For transparency, YOURLS will be maintained under the [Semantic Versioning](http://semver.org) principles as much as possible. Releases are numbered with the following format: `<major>.<minor>.<patch>` and the following guidelines:
  37 * Breaking backward compatibility bumps the major (and resets the minor and patch)
  38 * New additions without breaking backward compatibility bumps the minor (and resets the patch)
  39 * Bug fixes and misc changes bumps the patch
  40
  41 *[Release Archive](https://github.com/YOURLS/YOURLS/releases)*
  42
  43
  44 License
  45 -------
  46 Free software. Do whatever the hell you want with it.
  47 YOURLS is released under the [MIT license](LICENSE.md)
  48