Add a readme file

This commit is contained in:
Junior 2024-11-10 16:20:03 -05:00
parent 08e608eeb1
commit 3fe2e12da2

11
README.md Normal file
View File

@ -0,0 +1,11 @@
# Book Depot
A quick and dirty web interface to provide access for downloading e-books and sending them directly to a Kindle email address.
## Installation
* Clone repository and enter that folder
* Execute: `composer install`
* Copy `variables-dist.php` to `variables.php` and edit appropriately
* Create database on SQL server, create a DB user for this application, and import the `books_initial.sql`
* Create a cron job that runs `install/parsebooks.php` daily