diff --git a/README.md b/README.md index 98b3739..009925d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ # AdventureLog: Embark, Explore, Remember. 🌍 _**⚠️ AdvenutreLog is in early development and is not at all deployable in the current form!**_ +### *"Never forget an adventure with AdventureLog - Your ultimate travel companion!"* +----- +## Installation -### _"Never forget an adventure with AdventureLog - Your ultimate travel companion!"_ +### Docker 🐋 (Recomended) +1. Clone the repository +2. Edit the `docker-compose.yml` file and change the database password +3. Run `docker compose up -d` to build the image and start the container +4. Wait for the app to start up and migrate then visit the port and enjoy! ----