diff --git a/README.md b/README.md index 102dfff..eabae2d 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,34 @@ Visit our website: https://lubelogger.com Support this project by [Subscribing on Patreon](https://patreon.com/LubeLogger) or [Making a Donation](https://buy.stripe.com/aEU9Egc8DdMc9bO144) +Note: Commercial users are required to maintain an active Patreon subscripton to be compliant with our licensing model. + ## Why Because nobody should have to deal with a homemade spreadsheet or a shoebox full of receipts when it comes to vehicle maintenance. -## Screenshots -Screenshots +## Showcase +[Promotional Brochure](https://lubelogger.com/brochure.pdf) + +[Screenshots](/docs/screenshots.md) ## Demo Try it out before you download it! The live demo resets every 20 minutes. -[Live Demo](https://demo.lubelogger.com) Login using username "test" and password "1234" +[Live Demo - Latest Stable](https://demo.lubelogger.com) Login using username "test" and password "1234" + +## Download +LubeLogger is distributed both as a Docker image or a Windows Standalone Executable. + +Read this [Getting Started Guide](https://docs.lubelogger.com/Getting%20Started) on how to download either of them + +### Docker Setup (Manual Build) +1. Install Docker +2. Clone this repo +3. CHECK culture in .env file, default is en_US, also setup SMTP for user management if you want that. +4. Run `docker build -t lubelogger -f Dockerfile .` +5. CHECK docker-compose.yml and make sure the mounting directories look correct. +6. If using traefik, use docker-compose.traefik.yml +7. Run `docker-compose up` ## Dependencies - Bootstrap @@ -26,55 +44,3 @@ Try it out before you download it! The live demo resets every 20 minutes. - CsvHelper - Chart.js - Drawdown - -## Docker Setup (GHCR) -1. Install Docker -2. Run `docker pull ghcr.io/hargata/lubelogger:latest` -3. CHECK culture in .env file, default is en_US, this will change the currency and date formats. You can also setup SMTP Config here. -4. If using traefik, use docker-compose.traefik.yml -5. Run `docker-compose up` - -## Docker Setup (Manual Build) -1. Install Docker -2. Clone this repo -3. CHECK culture in .env file, default is en_US, also setup SMTP for user management if you want that. -4. Run `docker build -t lubelogger -f Dockerfile .` -5. CHECK docker-compose.yml and make sure the mounting directories look correct. -6. If using traefik, use docker-compose.traefik.yml -7. Run `docker-compose up` - -## Additional Docker Instructions - -### manual - -- build - -``` -docker build -t hargata/lubelog:latest . -``` - -- run - -``` -docker run -d hargata/lubelog:latest -``` - -add `-v` for persistent volumes as needed. Have a look at the docker-compose.yml for examples. - -## docker-compose - -- build image - -``` -docker compose build -``` - -- run - -``` -docker compose up - -# or variant with traefik labels: - -docker compose -f docker-compose.traefik.yml up -```