add README and LICENSE

2026-03-15 10:05:29 +01:00
parent 7f583179ae
commit fbdad56ef3
4 changed files with 709 additions and 10 deletions
@@ -0,0 +1,47 @@
+# Bocken Theme for Webtrees
+
+A [Webtrees](https://github.com/fisharebest/webtrees) theme plugin that provides consistent styling with [bocken.org](https://bocken.org).
+
+Built on top of [Argon Light Theme](https://github.com/06Games/Webtrees-ArgonLight) by Evan Galli, featuring a Nord-inspired color palette with dark/light mode support.
+
+## Features
+
+- Nord color palette with automatic dark/light mode and manual toggle
+- Custom logo and favicon for bocken.org branding
+- Search bar on the start page
+- Active navigation highlighting
+- Compact language selector
+
+## Installation
+
+1. Download or clone this repository.
+2. Copy the `BockenTheme` folder into your `webtrees/modules_v4` directory.
+3. Go to the webtrees control panel and enable the "Bocken" theme.
+
+## Development
+
+Prerequisites: [Node.js](https://nodejs.org/) and npm.
+
+```sh
+cd BockenTheme
+npm install
+npm run build
+```
+
+For development with live rebuilds:
+
+```sh
+npm run dev
+```
+
+## License
+
+Copyright (c) 2026 Alexander Bocken
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+See [LICENSE](LICENSE) for the full text.
+
+### Upstream
+
+The [Argon Light Theme](https://github.com/06Games/Webtrees-ArgonLight) by Evan Galli is licensed under the [ISC License](https://choosealicense.com/licenses/isc/).