Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
jonrandoem committed Jan 10, 2014
1 parent cbff61b commit f1ae73a
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
@@ -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).

0 comments on commit f1ae73a

Please sign in to comment.