19 lines
892 B
Markdown
19 lines
892 B
Markdown
# Trustme
|
|
|
|
Trustme is a clean and purpose-built API-only application. It follows best practices for clarity and scalability, while minimizing surface complexity.
|
|
|
|
This application does not include a frontend or UI layer — it is purely an API backend built to power external systems or interfaces.
|
|
|
|
## 📚 Documentation
|
|
|
|
To make development fast and debugging effortless, this project maintains two documentation files:
|
|
|
|
* [`./docs/ENDPOINTS.md`](./docs/ENDPOINTS.md) — a list of implemented endpoints and their intended usage
|
|
* [`./docs/COMMENTS.md`](./docs/COMMENTS.md) — a standard format for documenting views to quickly identify failing or related API routes
|
|
|
|
These are meant to be readable, searchable, and helpful directly from the code editor or terminal.
|
|
|
|
---
|
|
|
|
Feel free to explore or extend the codebase. The documentation files are the best place to start.
|