diff --git a/README.md b/README.md index 57a5d12..3549878 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@ # TI1 -The best thing to happen since yesturday at 3 pm +The best thing to happen since yesterday at 3 pm ## Usage -``` go run main.go ``` +To use this project, you can pull the Docker image from Docker Hub and run it using the following commands: -``` go build main.go ``` +### Pull the Docker Image -## Changelog +```sh +docker pull pigwin1/ti1:latest +``` -| Version | Changes | -|-----------|----------------------| -| 0.3 | it works as i want it to now (i think) now its time for a shiton of trubleshooting (yay!) | -| 0.2 | split the project into multiple files to make it more readable | -| 0.1.1-7 | fixing the json print output to actualy print out all the data and sutch | -| 0.1 | literaly most of the project | +### Run the Docker Container +```sh +docker run -d --name ti1-container -e DB_HOST= -e DB_PORT= -e DB_USER= -e DB_PASSWORD= -e DB_NAME= -e DB_SSLMODE= pigwin1/ti1:latest +``` +Replace ``, ``, ``, ``, ``, and `` with your actual database configuration values. + +### Docker Hub Repository +You can find the Docker image on Docker Hub at the following link: + +https://hub.docker.com/repository/docker/pigwin1/ti1/general -ps i know this is 100% not the way version numbers are supost to work but i'm just cool like that \ No newline at end of file