mirror of
https://github.com/cydrobolt/polr.git
synced 2024-11-10 04:02:28 +01:00
46 lines
2.5 KiB
Markdown
46 lines
2.5 KiB
Markdown
# [](https://project.polr.me)
|
|
#####v2 Devel
|
|
|
|
:aerial_tramway: A modern, minimalist, and lightweight URL shortener.
|
|
|
|
[]()
|
|
[](https://travis-ci.org/cydrobolt/polr)
|
|
[](http://polr.readthedocs.org/en/2.0-dev/)
|
|
|
|
Welcome to Polr's 2.0 development branch.
|
|
Please keep in mind 2.0 is currently unstable, and should not be used in production.
|
|
|
|
Polr is an enterprise-class open-source link shortening web application designed to operate at many scales, built on the Software-as-a-Service paradigm. It allows you to host your own URL shortener, to brand your URLs, and to gain control over your data. Polr is especially easy to use, and provides a modern, themable feel.
|
|
|
|
[Getting Started](http://docs.polr.me/en/2.0-dev/user-guide/installation/) - [API Documentation](http://docs.polr.me/en/2.0-dev/developer-guide/api/) - [Contributing](https://github.com/cydrobolt/polr/blob/2.0-dev/CONTRIBUTING.md) - [Bugs](https://github.com/cydrobolt/polr/issues) - [IRC](http://webchat.freenode.net/?channels=#polr)
|
|
|
|
#### Quickstart
|
|
|
|
Polr is written in PHP and Laravel, using MySQL as its primary database.
|
|
|
|
- To get started with Polr on your server, check out the [installation guide](http://docs.polr.me/en/2.0-dev/user-guide/installation/). You can clone this repository, or download a [release](https://github.com/cydrobolt/polr/releases).
|
|
- To get started with the Polr API, check out the [API guide](http://docs.polr.me/en/2.0-dev/developer-guide/api/).
|
|
|
|
####Versioning
|
|
|
|
Polr uses [Semantic Versioning](http://semver.org/)
|
|
|
|
####License
|
|
|
|
|
|
Copyright (C) 2013-2016 Chaoyi Zha
|
|
|
|
This program is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU General Public License
|
|
as published by the Free Software Foundation; either version 2
|
|
of the License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|