docs: update and add readme and contributing docs

This commit is contained in:
2026-03-01 11:37:26 +01:00
parent 0d001a4118
commit 05159e454a
5 changed files with 657 additions and 2 deletions

View File

@@ -1,9 +1,27 @@
# Tímmál
<h1 align="center">Timmal</h1>
<div align="center">
<strong>
A privacy-first work time tracking application
</strong>
</div>
<br/>
<div align="center">
<!-- Wakapi -->
<img alt="Coding Time Badge" src="">
<!-- Emacs -->
<a href="https://www.gnu.org/software/emacs/"><img src="https://img.shields.io/badge/Emacs-30.2-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=white" /></a>
</div>
<br/>
**A privacy-first work time tracking application**
Track time spent on tickets, generate Excel-compatible reports, and streamline your work report workflow. Built for developers and consultants who need accurate time tracking with data integrity guarantees.
> **🤖 AI-Assisted Development Notice**: This project uses Claude Code as a development assistant for task planning, code organization, and workflow management. However, all code is human-written, reviewed, and validated by the project maintainer. AI is used as a productivity tool, not as the author of the implementation. For more information regarding the allowed usage of AI when working on Timmal, see [file:./AGENTS.md].
> **⚠️ Development Status**: This project is in early development. Core features are currently being implemented following a specification-driven approach.
## Features
- **Smart Timer**: Start/stop timers on tasks with automatic persistence across page refreshes and browser crashes
@@ -131,4 +149,4 @@ Check out the [Nuxt deployment documentation](https://nuxt.com/docs/getting-star
## License
This repository is under the AGPL-3.0 licence.
This repository is under the AGPL-3.0 licence. See [file:./LICENSE.md].