-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from timia2109/feature/migrations#
Update README
- Loading branch information
Showing
1 changed file
with
17 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,18 @@ | ||
# DayFlags | ||
A simple service to flag days | ||
A simple service to flag days. This repo is currently work in progress | ||
|
||
## Idea | ||
This service helps to mark days. It can be used to collect events in the past or to announce events in the future. | ||
|
||
## Definition | ||
### Realm | ||
A realm is a defined area for the other objects. Everything within a realm is unique. | ||
|
||
### FlagType | ||
FlagTypes that define the allowed DayFlags. A FlagType can occur in a FlagGroup. | ||
|
||
### FlagGroup | ||
A FlagGroup is a grouping of multiple FlagTypes. It can be used for queries. There is a flag if only one FlagType of the group is allowed on a date. | ||
|
||
### DayFlag | ||
DayFlags are used to specify the occurrence of a FlagType on a calendar date. |