1
0
mirror of https://github.com/cydrobolt/polr.git synced 2024-11-09 11:42:28 +01:00

Updates to README

This commit is contained in:
Chaoyi Zha 2018-01-10 18:13:04 -05:00
parent c16c477d0b
commit 992852138e

View File

@ -5,7 +5,7 @@
[![GitHub license](https://img.shields.io/badge/license-GPLv2%2B-blue.svg)]() [![GitHub license](https://img.shields.io/badge/license-GPLv2%2B-blue.svg)]()
[![GitHub release](https://img.shields.io/github/release/cydrobolt/polr.svg)](https://github.com/cydrobolt/polr/releases) [![GitHub release](https://img.shields.io/github/release/cydrobolt/polr.svg)](https://github.com/cydrobolt/polr/releases)
[![Builds status](https://travis-ci.org/cydrobolt/polr.svg)](https://travis-ci.org/cydrobolt/polr) [![Builds status](https://travis-ci.org/cydrobolt/polr.svg)](https://travis-ci.org/cydrobolt/polr)
[![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](http://polr.readthedocs.org/en/latest/) [![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](http://polr.readthedocs.org/en/latest/)
@ -17,7 +17,7 @@ Polr is an intrepid, self-hostable open-source link shortening web application w
Polr is written in PHP and Lumen, using MySQL as its primary database. Polr is written in PHP and Lumen, using MySQL as its primary database.
- To get started with Polr on your server, check out the [installation guide](http://docs.polrproject.org/en/latest/user-guide/installation/). You can clone this repository, or download a [release](https://github.com/cydrobolt/polr/releases). - To get started with Polr on your server, check out the [installation guide](http://docs.polrproject.org/en/latest/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.polrproject.org/en/latest/developer-guide/api/). - To get started with the Polr API, check out the [API guide](http://docs.polrproject.org/en/latest/developer-guide/api/).
@ -45,11 +45,17 @@ There are breaking changes between 2.x and 1.x; it is not yet possible to automa
* Safari - [Polr.safariextension](https://github.com/cleverdevil/Polr.safariextension) * Safari - [Polr.safariextension](https://github.com/cleverdevil/Polr.safariextension)
#### Sponsors #### Libraries
* Python - [mypolr](https://github.com/fauskanger/mypolr)
#### Acknowledgements
We would like to thank Oregon State University's Open Source Lab for providing resources for our infrastructure. The Polr website and demo are hosted on their infrastructure. We would like to thank Oregon State University's Open Source Lab for providing resources for our infrastructure. The Polr website and demo are hosted on their infrastructure.
<a href="//osuosl.org"><img height="100em" src="http://i.imgur.com/1VtLxyX.png" /></a> <a href="//osuosl.org"><img height="100em" src="http://i.imgur.com/1VtLxyX.png" /></a>
Thank you to [lastspark](https://thenounproject.com/lastspark/) for providing our logo's icon.
#### Versioning #### Versioning
Polr uses [Semantic Versioning](http://semver.org/) Polr uses [Semantic Versioning](http://semver.org/)
@ -58,7 +64,7 @@ Polr uses [Semantic Versioning](http://semver.org/)
#### License #### License
Copyright (C) 2013-2017 Chaoyi Zha Copyright (C) 2013-2018 Chaoyi Zha
This program is free software; you can redistribute it and/or This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License modify it under the terms of the GNU General Public License