Skip to content

Add formula syntax section to readme #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stefan-brus-frequenz merged 1 commit into from
Jun 24, 2025
Merged

Add formula syntax section to readme #106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ By providing an array of key metrics and aggregation features, it accommodates v
use-cases and empowers users to make well-informed decisions in different operational
contexts.

## Formula Syntax

The syntax and implementation of the aggregation formulas supported by this API are defined in a separate project:
the [Frequenz Microgrid Formula Engine](https://github.com/frequenz-floss/frequenz-microgrid-formula-engine-rs?tab=readme-ov-file#frequenz-microgrid-formula-engine-rs).
For details on how to write and structure formulas, including supported functions and operators, refer to its README.

## Contributing

If you want to know how to build this project and contribute to it, please
Expand Down
Loading