Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cbff61b
commit f1ae73a
Showing
1 changed file
with
18 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,42 @@ | ||
ttrss-qrcode | ||
========== | ||
|
||
###About | ||
About | ||
---------- | ||
|
||
An on-demand QR-Code generator plugin for TTRSS (http://tt-rss.org). The QR-Codes are generated through PHP and do not require any external service. | ||
|
||
This plugin is licensed under [MIT License](https://github.com/jonrandoem/ttrss-qrcode/blob/master/LICENSE). | ||
The QR-Codes are generated thanks to the [phpqrcode library](http://phpqrcode.sourceforge.net/). | ||
|
||
Once created, any QR-Code is saved as a PNG on the server, and is cached for future serving. Make sur the "cache" subfolder of the plugin is writeable by your webserver. | ||
|
||
This plugin has been tested on the version 1.10 of TTRSS. | ||
|
||
|
||
###Installation | ||
Installation | ||
---------- | ||
|
||
1. Download ZIP and unzip it | ||
2. Rename the extracted folder from "ttrss-qrcode-master" to "qrcodegen" | ||
3. Upload the "qrcodegen" folder inside the "plugins" folder of your TTRSS installation | ||
4. Activate the plugin through the configuration area of TTRSS | ||
|
||
|
||
###Features | ||
Todo | ||
---------- | ||
|
||
The QR-Codes are generated thanks to the [phpqrcode library](http://phpqrcode.sourceforge.net/). | ||
- Make the QR codes appear in a dialog instead of generating them inline of the article. | ||
|
||
Once created, any QR-Code is saved as a PNG on the server, and is cached for future serving. Make sur the "cache" subfolder of the plugin is writeable by your webserver. | ||
|
||
|
||
|
||
###Credits | ||
Credits | ||
---------- | ||
|
||
* phpqrcode [Website](http://phpqrcode.sourceforge.net/) | [LGPL License](http://sourceforge.net/p/phpqrcode/git/ci/master/tree/LICENSE) | ||
|
||
|
||
License | ||
---------- | ||
|
||
This plugin is licensed under [MIT License](https://github.com/jonrandoem/ttrss-qrcode/blob/master/LICENSE). | ||
|