From 306734bceee04cdcb1f50641b5ccf44faff6f7ec Mon Sep 17 00:00:00 2001 From: Simon Date: Thu, 2 Oct 2025 15:26:23 +0200 Subject: [PATCH] docs: reduce horizontal lines --- README.md | 32 -------------------------------- 1 file changed, 32 deletions(-) diff --git a/README.md b/README.md index 00aa220..e8b9bec 100644 --- a/README.md +++ b/README.md @@ -5,22 +5,16 @@ [![CI Status](https://img.shields.io/badge/build-pending-lightgrey.svg)](link-to-ci) ![License](https://img.shields.io/badge/license-TBD-blue) ---- - ## 🚧 Project Status ⚠️ **Early development** — not production-ready. Expect breaking changes. Contributions and feedback are welcome! ---- - ## ✨ Overview Mila is a free and open-source membership management tool designed for real club needs. It is **self-hosting friendly**, aims for **accessibility and GDPR compliance**, and focuses on **usability** instead of feature overload. ---- - ## 💡 Why Mila? Most membership tools for clubs are either: @@ -38,15 +32,11 @@ Most membership tools for clubs are either: Our philosophy: **software should help people spend less time on administration and more time on their community.** ---- - ## 📸 Screenshots ![Screenshot placeholder](docs/images/screenshot.png) *This is how Mila might look in action.* ---- - ## 🔑 Features - ✅ Manage member data with ease @@ -60,8 +50,6 @@ Our philosophy: **software should help people spend less time on administration - 🚧 Accessibility, GDPR, usability improvements - 🚧 Email sending ---- - ## 🚀 Quick Start (Development) ### Prerequisites @@ -125,8 +113,6 @@ mix archive.install hex phx_new 1.7.20 > Note: running `mix local.hex` must be done inside the repo folder, > because `.tool-versions` defines the Erlang/Elixir versions. ---- - ### Run the app 1. Copy env file: @@ -145,8 +131,6 @@ mix archive.install hex phx_new 1.7.20 - Mail UI: - Postgres: `localhost:5000` ---- - ## 🔐 Testing SSO locally Mila uses OIDC for Single Sign-On. In development, a local **Rauthy** instance is provided. @@ -165,8 +149,6 @@ Mila uses OIDC for Single Sign-On. In development, a local **Rauthy** instance i Now you can log in to Mila via OIDC! ---- - ## ⚙️ Configuration - **Env vars:** see `.env.example` @@ -177,8 +159,6 @@ Now you can log in to Mila via OIDC! - User/pass: `postgres` / `postgres` - DB: `mila_dev` ---- - ## 🏗️ Architecture - **Backend:** Elixir, Phoenix 1.8, LiveView 1.1, Ash Framework @@ -193,8 +173,6 @@ Code structure: - `lib/mv_web/` — Phoenix controllers, LiveViews, components - `assets/` — frontend assets (Tailwind, JS, etc.) ---- - ## 🧑‍💻 Development Useful `just` commands: @@ -205,8 +183,6 @@ Useful `just` commands: - `just reset-database` — reset local DB - `just regen-migrations ` — regenerate migrations ---- - ## 📦 Deployment A production release image is built via the provided `Dockerfile`. @@ -214,8 +190,6 @@ Entrypoint: `/app/bin/server`. More detailed deployment docs are planned. ---- - ## 🤝 Contributing We welcome contributions! @@ -223,18 +197,12 @@ We welcome contributions! - Please follow existing code style and conventions. - Expect breaking changes while the project is in early development. ---- - ## 📄 License **License: TBD** (Free and Open Source). A proper license file will be added soon. ---- - ## 📬 Contact - Issues: [GitLab Issues](https://git.local-it.org/local-it/mitgliederverwaltung/-/issues) - Community links: coming soon. - ----