Files
MIND/README.md
Casvt 6fa9c10f2a Doc update (#67)
* Updated README

* Added EXPOSE to Dockerfile for Docker Desktop

* Refactored docker compose file

* Updated CONTRIBUTING

* Docs update

* Added docs for sending files

* Added styling of scroll bar

* Fixed various colors

* Fixed Dockerfile exposed port

* Updated api docs for merging

* Attempt at fixing merge problems
2024-03-10 14:17:03 +01:00

46 lines
2.2 KiB
Markdown

# MIND
[![Docker Pulls](https://img.shields.io/docker/pulls/mrcas/mind.svg)](https://hub.docker.com/r/mrcas/mind)
__A simple self hosted reminder application that can send push notifications to your device. Set the reminder and forget about it!__
Mind is a simple self hosted application for creating reminders that get pushed to your device using the [Apprise](https://github.com/caronc/apprise) API. You can send messages to just about every platform, including scheduled emails!
## Workings
MIND can be used for sending notifications at the desired time. This can be a set time, like a yearly reminder for a birthday, or at a button click, to easily send a predefined notification when you want to. The notification can be sent to 80+ platforms with the integration of [Apprise](https://github.com/caronc/apprise).
## Features
- Works cross-timezone
- Notifications are sent with second-precision
- Fine control over repetition: single time, time interval, certain weekdays or manual trigger.
- Uses the [Apprise library](https://github.com/caronc/apprise), giving you 80+ platforms to send notifications to and the option to send to multiple platforms for each reminder
- Easily manage the reminders with sorting options, search ability and color coding
- An admin panel for user management, settings and backups
- Docker image available
- Mobile friendly web-interface
- API available
## Installation, support and documentation
- For instructions on how to install MIND, see the [installation documentation](https://casvt.github.io/MIND/installation/installation)
- For support, a [discord server](https://discord.gg/nMNdgG7vsE) is available or [make an issue](https://github.com/Casvt/MIND/issues)
- For all documentation, see the [documentation hub](https://casvt.github.io/MIND).
## Screenshots
<img src="https://github.com/Casvt/Kapowarr/assets/88994465/f55c895b-7975-4a3e-88a0-f8e2a148bf8a" style="width: max(45%, 400px); margin: .5rem;">
<img src="https://github.com/Casvt/Kapowarr/assets/88994465/63d72943-0c88-4315-9a8a-01a5dc5f6f15" style="width: max(45%, 400px); margin: .5rem;">
<img src="https://github.com/Casvt/Kapowarr/assets/88994465/1f9cc9a2-ced5-49a2-b779-93528bb50bd4" style="width: max(45%, 400px); margin: .5rem;">