Merge branch 'release/1.0.2'

secondmanveran · Oct 16, 2017 · 884c902 · 884c902
2 parents 5c0db23 + 85bd6ea
commit 884c902
Show file tree

Hide file tree

Showing 18 changed files with 13 additions and 612 deletions.
diff --git a/README.md b/README.md
@@ -1,20 +1,23 @@
-# Lngx Url Shortener Service
---
+![Polr Logo](https://docs.lngx.org/img/logo.png)
 
-Lngx 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. Lngx is especially easy to use, and provides a modern, themeable feel.
+[![GitHub license](https://img.shields.io/badge/license-GPLv2%2B-orange.svg)](about/license)
+[![GitHub release](https://img.shields.io/github/release/19peaches/lngx.svg)](https://github.com/19peaches/lngx/releases)
+
+Lngx is a beautiful, modern, lightweight, and minimalist open-source URL shortening application. It allows you to host your own URL shortener, to brand your URLs, and to gain control over your data. Lngx is especially easy to use, and provides a modern, themeable interface.
+
+Lngx is built on the original [Polr](https://github.com/cydrobolt/polr) application created and maintained by [Chaoyi Zha](https://cydrobolt.com), with great thanks for such an elegant approach.
 
 ### Quickstart
 
 Lngx is written in PHP and Lumen, using MySQL as its primary database.
 
+For complete installtion directions please refer to the [Lngx Documentation](https://docs.lngx.org).
+
 Installation TL;DR: clone or download this repository, set document root to `public/`, create MySQL database, go to `yoursite.com/setup` and follow instructions.
 
 ### Upgrading Lngx
-*Upgrading from 1.x:*
-
-There are breaking changes between 2.x and 1.x; it is not yet possible to automatically upgrade to 2.x.
 
-*Upgrading from 2.x:*
+*Upgrading from 1.x:*
  - Back up your database and files
  - Update by using `git pull` or downloading a release
  - Run `composer install --no-dev -o` to ensure dependencies are up to date

diff --git a/docs/about/contributing.md b/docs/about/contributing.md
diff --git a/docs/about/contributors.md b/docs/about/contributors.md
diff --git a/docs/about/license.md b/docs/about/license.md
diff --git a/docs/css/base.css b/docs/css/base.css
diff --git a/docs/developer-guide/api.md b/docs/developer-guide/api.md
diff --git a/docs/developer-guide/api_errors.md b/docs/developer-guide/api_errors.md
diff --git a/docs/developer-guide/libraries.md b/docs/developer-guide/libraries.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/logo.png b/docs/logo.png