krtmn/README.md

50 lines
2.8 KiB
Markdown
Raw Normal View History

2016-04-13 22:02:46 +02:00
![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)
========
2012-03-05 20:29:22 +01:00
2016-04-13 22:02:46 +02:00
**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.
2012-03-05 20:29:22 +01:00
2016-04-13 22:02:46 +02:00
Quick Start
-----------
To get started, check [yourls.org](http://yourls.org)!
Learn more tweaks in the [Wiki documentation](https://github.com/YOURLS/YOURLS/wiki/).
2012-03-08 14:44:47 +01:00
2016-04-13 22:02:46 +02:00
Community news, tips and tricks
-------------------------------
* Read and subscribe to the [The Official YOURLS Blog](http://blog.yourls.org)
* Follow [@yourls](http://twitter.com/yourls)
* Subscribe to the [YOURLS User Newsletter](http://yourls.org/newsletter) (infrequent, low volume)
2012-03-08 14:44:47 +01:00
2012-03-05 20:29:22 +01:00
2016-04-13 22:02:46 +02:00
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)
2012-03-05 20:29:22 +01:00
2012-03-08 14:44:47 +01:00
2016-04-13 22:02:46 +02:00
Bug Tracker
-----------
__Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/YOURLS/YOURLS/wiki/Bug-Report).__
2012-03-05 20:29:22 +01:00
2016-04-13 22:02:46 +02:00
Have a **new bug** to report? [Please open a new issue](https://github.com/YOURLS/YOURLS/issues/new?title=Issue+title+--+be+DESCRIPTIVE&body=Before%20any%20bug%20report%2C%20check%20you%20are%20using%20the%20LATEST%20release%20or%20the%20development%20branch.%20Make%20sure%20you%20have%20SEARCHED%20closed%20issues%20first.%20Read%20the%20GUIDELINES%20linked%20in%20the%20yellow%20notice%20box%20above.%20Now%20please%20DELETE%20these%20first%20lines.%0A%0A%0A%23%23%23%20Reproducible%20Bug%20Summary%20%0A%0A1.%20This%20is%20the%20first%20step%0A2.%20second%20step%0A3.%20etc...%0A%0AThis%20is%20a%20bug%20because...%0A%0A%0A%23%23%23%20Technical%20details%0A%0A*%20YOURLS%20version%3A%0A*%20PHP%20version%3A%0A*%20Any%20other%20useful%20information%20depending%20on%20context%20%28server%20version%2C%20mysql%20version%2C%20browser%20version%2C%20OS%20version...%29%0A).
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: `<major>.<minor>.<patch>` 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)*
License
-------
Free software. Do whatever the hell you want with it.
YOURLS is released under the [MIT license](LICENSE.md)
2012-03-05 20:29:22 +01:00