diff options
| author | Chaoyi Zha <summermontreal@gmail.com> | 2016-09-12 02:20:45 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-12 02:20:45 +0300 |
| commit | e76d3313df88fc65ad9ddc6b66af332285c12515 (patch) | |
| tree | 193e56dc3a3468bb009b9b808d3e4ffd5da7be71 /README.md | |
| parent | 5d2c141fe9c48a141b6aad20f727e57d342dfa7e (diff) | |
README revamp
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 10 insertions, 11 deletions
@@ -6,18 +6,11 @@ [](https://travis-ci.org/cydrobolt/polr) [](http://polr.readthedocs.org/en/latest/) -Polr is an open-source link shortening web application designed to operate at a brisk pace while offering a full-featured experience. 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. +Polr is an intrepid, self-hostable open-source link shortening web application with a robust API. 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/latest/user-guide/installation/) - [API Documentation](http://docs.polr.me/en/latest/developer-guide/api/) - [Contributing](https://github.com/cydrobolt/polr/blob/master/CONTRIBUTING.md) - [Bugs](https://github.com/cydrobolt/polr/issues) - [IRC](http://webchat.freenode.net/?channels=#polr) -### Upgrading from 1.x - -**Please do not attempt to upgrade directly to 2.x.** - -Polr 1.x currently cannot be upgraded to 2.x automatically. There are breaking changes in the API, configuration files, and database structure. A migration will be provided once 2.0 stable is officially released. In the meantime, it is okay to upgrade between different versions in the 1.x arch, which do not have breaking changes. - - -#### Quickstart +### Quickstart Polr is written in PHP and Laravel, using MySQL as its primary database. @@ -25,9 +18,9 @@ Polr is written in PHP and Laravel, using MySQL as its primary database. - To get started with the Polr API, check out the [API guide](http://docs.polr.me/en/latest/developer-guide/api/). -_Installation TL;DR: clone or download this repository, set document root to `public/`, MySQL create database, go to `yoursite.com/setup`_ +Installation TL;DR: clone or download this repository, set document root to `public/`, create MySQL database, go to `yoursite.com/setup and follow instructions` -#### Demo +### Demo Polr operates a demo instance at [demo.polr.me](http://demo.polr.me). You can use the demo instance to develop your API implementation, try out the admin panel, or simply experience the app without needing to install it on your own servers. The demo instance may be periodically reset, so please do not use the demo as a production URL shortener. @@ -35,6 +28,12 @@ Admin username: demo-admin (password is same as username) Normal user username: demo-user (password is same as username) +### Upgrading Polr + +**Please do not attempt to upgrade directly to 2.x.** + +Polr 1.x currently cannot be upgraded to 2.x automatically. There are breaking changes in the API, configuration files, and database structure. It is safe to upgrade between different versions in the 1.x arch, which do not have breaking changes. Always backup your database and configuration files before upgrading Polr. + #### Browser Extensions * Safari - [Polr.safariextension](https://github.com/cleverdevil/Polr.safariextension). |