diff --git a/README.md b/README.md index a771ba5..8634f3d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ # AdventureLog: Embark, Explore, Remember. 🌍 _**âš ī¸ AdventureLog is in early development and is not recommended for production use until version 1.0!**_ -### *"Never forget an adventure with AdventureLog - Your ultimate travel companion!"* ------ + +### _"Never forget an adventure with AdventureLog - Your ultimate travel companion!"_ + +--- + ## Installation ### 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 @@ -14,3 +18,22 @@ _**âš ī¸ AdventureLog is in early development and is not recommended for produc **Note**: The `ORIGIN` variable is required for CSRF protection. It can be omitted if using a reverse proxy or other HTTPS service. +## About AdventureLog â„šī¸ + +AdventureLog is a Svelte Kit application that utilizes a PostgreSQL database. Users can log the adventures they have experienced, as well as plan future ones. Key features include: + +- Logging past adventures with fields like name, date, location, description, and rating. +- Planning future adventures with similar fields. +- Tagging different activity types for better organization. +- Viewing countries, regions, and marking visited regions. + +AdventureLog aims to be your ultimate travel companion, helping you document your adventures and plan new ones effortlessly. + +AdventureLog is liscensed under the GNU General Public License v3.0. + +## Roadmap đŸ›Ŗī¸ + +- Improved mobile device support +- Password reset functionality +- Improved error handling +- Handling of adventure cards with variable width diff --git a/src/lib/config.ts b/src/lib/config.ts index dad49ef..5f179f3 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -1,3 +1,3 @@ -export let appVersion = "Web 0.1.6-alpha"; +export let appVersion = "Web 0.1.7-alpha"; export let appTitle = "AdventureLog"; -export let copyrightYear = "2024" +export let copyrightYear = "2024";