Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix some README links and standardize structure
[ci skip]
- Loading branch information
Showing
1 changed file
with
37 additions
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,127 +1,60 @@ | ||
| [](https://yourls.org) [](https://travis-ci.org/YOURLS/YOURLS) [](#backers) | ||
| [](#sponsors)  | ||
| ======== | ||
| <h1 align="center"> | ||
| <a href="https://yourls.org"> | ||
| <img src="images/yourls-logo.png" alt="YOURLS"> | ||
| </a> | ||
| </h1> | ||
|
|
||
| > Your Own URL Shortener | ||
| [](https://travis-ci.org/YOURLS/YOURLS) [](https://packagist.org/packages/yourls/yourls) [](https://opencollective.com/yourls#contributors) | ||
| [](#sponsors) | ||
|
|
||
| **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 and open-source. | ||
|
|
||
| ## Quick Start | ||
|
|
||
| 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 | ||
| ------------------------------- | ||
| ## Community news, tips and tricks | ||
|
|
||
| * Read and subscribe to the [The Official YOURLS Blog](http://blog.yourls.org) | ||
| * Follow [@yourls](https://twitter.com/yourls) on Twitter | ||
| * Subscribe to the [YOURLS User Newsletter](https://yourls.org/newsletter) (infrequent, low volume) | ||
|
|
||
|
|
||
| Keep track of development | ||
| ------------------------- | ||
| ## Keep track of development | ||
|
|
||
| * Follow [@yourls_dev](https://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) | ||
| * Check the [Road map](https://github.com/orgs/YOURLS/projects/1) | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| 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](https://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)* | ||
|
|
||
|
|
||
| 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)] | ||
|
|
||
| <a href="https://opencollective.com/yourls/sponsor/0/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/0/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/1/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/1/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/2/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/2/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/3/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/3/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/4/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/4/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/5/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/5/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/6/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/6/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/7/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/7/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/8/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/8/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/9/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/9/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/10/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/10/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/11/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/11/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/12/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/12/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/13/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/13/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/14/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/14/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/15/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/15/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/16/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/16/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/17/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/17/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/18/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/18/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/19/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/19/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/20/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/20/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/21/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/21/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/22/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/22/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/23/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/23/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/24/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/24/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/25/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/25/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/26/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/26/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/27/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/27/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/28/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/28/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/sponsor/29/website" target="_blank"><img src="https://opencollective.com/yourls/sponsor/29/avatar.svg"></a> | ||
|
|
||
| Backers | ||
| ------- | ||
|
|
||
| Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/yourls#backer)] | ||
|
|
||
| <a href="https://opencollective.com/yourls/backer/0/website" target="_blank"><img src="https://opencollective.com/yourls/backer/0/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/1/website" target="_blank"><img src="https://opencollective.com/yourls/backer/1/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/2/website" target="_blank"><img src="https://opencollective.com/yourls/backer/2/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/3/website" target="_blank"><img src="https://opencollective.com/yourls/backer/3/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/4/website" target="_blank"><img src="https://opencollective.com/yourls/backer/4/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/5/website" target="_blank"><img src="https://opencollective.com/yourls/backer/5/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/6/website" target="_blank"><img src="https://opencollective.com/yourls/backer/6/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/7/website" target="_blank"><img src="https://opencollective.com/yourls/backer/7/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/8/website" target="_blank"><img src="https://opencollective.com/yourls/backer/8/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/9/website" target="_blank"><img src="https://opencollective.com/yourls/backer/9/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/10/website" target="_blank"><img src="https://opencollective.com/yourls/backer/10/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/11/website" target="_blank"><img src="https://opencollective.com/yourls/backer/11/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/12/website" target="_blank"><img src="https://opencollective.com/yourls/backer/12/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/13/website" target="_blank"><img src="https://opencollective.com/yourls/backer/13/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/14/website" target="_blank"><img src="https://opencollective.com/yourls/backer/14/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/15/website" target="_blank"><img src="https://opencollective.com/yourls/backer/15/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/16/website" target="_blank"><img src="https://opencollective.com/yourls/backer/16/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/17/website" target="_blank"><img src="https://opencollective.com/yourls/backer/17/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/18/website" target="_blank"><img src="https://opencollective.com/yourls/backer/18/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/19/website" target="_blank"><img src="https://opencollective.com/yourls/backer/19/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/20/website" target="_blank"><img src="https://opencollective.com/yourls/backer/20/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/21/website" target="_blank"><img src="https://opencollective.com/yourls/backer/21/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/22/website" target="_blank"><img src="https://opencollective.com/yourls/backer/22/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/23/website" target="_blank"><img src="https://opencollective.com/yourls/backer/23/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/24/website" target="_blank"><img src="https://opencollective.com/yourls/backer/24/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/25/website" target="_blank"><img src="https://opencollective.com/yourls/backer/25/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/26/website" target="_blank"><img src="https://opencollective.com/yourls/backer/26/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/27/website" target="_blank"><img src="https://opencollective.com/yourls/backer/27/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/28/website" target="_blank"><img src="https://opencollective.com/yourls/backer/28/avatar.svg"></a> | ||
| <a href="https://opencollective.com/yourls/backer/29/website" target="_blank"><img src="https://opencollective.com/yourls/backer/29/avatar.svg"></a> | ||
|
|
||
|
|
||
| Contributors | ||
| ------------ | ||
|
|
||
| YOURLS is made by these fine folks : | ||
| <a href="https://github.com/YOURLS/YOURLS/graphs/contributors"><img src="https://opencollective.com/yourls/contributors.svg?width=890" /></a> | ||
|
|
||
| License | ||
| ------- | ||
| Free software. Do whatever the hell you want with it. | ||
| YOURLS is released under the [MIT license](LICENSE). | ||
| ## Sponsors | ||
|
|
||
| Does your company use YOURLS? Help support our open-source development efforts by [becoming a sponsor](https://opencollective.com/yourls). | ||
|
|
||
| [](https://opencollective.com/yourls/backer/0/website) | ||
| [](https://opencollective.com/yourls/backer/1/website) | ||
| [](https://opencollective.com/yourls/backer/2/website) | ||
| [](https://opencollective.com/yourls/backer/3/website) | ||
| [](https://opencollective.com/yourls/backer/4/website) | ||
| [](https://opencollective.com/yourls/sponsor/0/website) | ||
| [](https://opencollective.com/yourls/sponsor/1/website) | ||
| [](https://opencollective.com/yourls/sponsor/2/website) | ||
| [](https://opencollective.com/yourls/sponsor/3/website) | ||
| [](https://opencollective.com/yourls/sponsor/4/website) | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| Free software. Do whatever the hell you want with it. | ||
| YOURLS is released under the [MIT license](LICENSE). |