Skip to content

Commit

Permalink
Merge pull request #3 from timia2109/feature/migrations#
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
timia2109 authored Feb 15, 2024
2 parents c7868e7 + af076b0 commit b36055b
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
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.

0 comments on commit b36055b

Please sign in to comment.