[![yourls](images/yourls-logo.png)](https://yourls.org) [![Build Status](https://api.travis-ci.org/YOURLS/YOURLS.svg?branch=master)](https://travis-ci.org/YOURLS/YOURLS) [![OpenCollective](https://opencollective.com/yourls/backers/badge.svg)](#backers) [![OpenCollective](https://opencollective.com/yourls/sponsors/badge.svg)](#sponsors) ![♥](https://img.shields.io/badge/made%20with-%E2%9D%A4-ff69b4.svg) ======== **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, analytics, plugins, and more. It's free. Quick Start ----------- To get started, check [yourls.org](https://yourls.org)! Learn more tweaks in the [Wiki documentation](https://github.com/YOURLS/YOURLS/wiki/). Community news, tips and tricks ------------------------------- * Read and subscribe to the [The Official YOURLS Blog](http://blog.yourls.org) * Follow [@yourls](https://twitter.com/yourls) * Subscribe to the [YOURLS User Newsletter](http://yourls.org/newsletter) (infrequent, low volume) Keep track of development ------------------------- * Follow [@yourls_dev](http://twitter.com/yourls_dev) * Check [commit messages](https://github.com/YOURLS/YOURLS/commits/master) * Check the [Road map](https://github.com/YOURLS/YOURLS/wiki/Road-Map) Bug Tracker ----------- __Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/YOURLS/YOURLS/wiki/Bug-Report).__ Have a **new bug** to report? [Please open a new issue](https://github.com/YOURLS/YOURLS/issues/new?title=Issue+title+--+be+DESCRIPTIVE). Versioning ---------- 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: `..` and 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)* Sponsors ------- Does your company use YOURLS? Help the project, become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/yourls#sponsor)] Backers ------- Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/yourls#backer)] Contributors ------------ YOURLS is made by these fine folks : License ------- Free software. Do whatever the hell you want with it. YOURLS is released under the [MIT license](LICENSE.md)