1
0
mirror of https://github.com/cydrobolt/polr.git synced 2024-09-19 23:21:47 +02:00
polr/README.md
2015-11-15 10:51:02 -05:00

39 lines
2.0 KiB
Markdown

# [![Logo](http://i.imgur.com/aOtrJNz.png)]()
#####v2 Devel
:aerial_tramway: A modern, minimalist, and lightweight URL shortener.
[![GitHub license](https://img.shields.io/badge/license-GPLv2%2B-blue.svg)]()
[![2.0 status](https://img.shields.io/badge/devel-2.0-red.svg)]()
[![GitHub release](https://img.shields.io/badge/stable-1.4.1-blue.svg)]()
[![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](http://polr.readthedocs.org/en/2.0-dev/)
Welcome to Polr's 2.0 development branch.
Please keep in mind 2.0 is pre-alpha, and should not be used in production. This version of Polr break existing 0.x and 1.x installations, but migrations will be provided.
Once 2.0 is complete, it will supercede the current stable version of Polr, but the latest 1.x version will continue to be available as a legacy release for users who cannot make the switch to 2.0 due to their host or do not meet the new server requirements.
Polr 2.0 moves away from `mysqli`, rather taking on `PDO` with `Eloquent`. Routing and autoloading will be done with `composer` and the Lumen web framework. Although unlikely, this change may cause those on shared hosting to be unable to install Polr.
#### [Installation Instructions](http://docs.polr.me/en/2.0-dev/user-guide/installation/)
####License
Copyright (C) 2013-2015 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.