From cacde8ae888139cf5d10dc87c8baa1087b7a7fd9 Mon Sep 17 00:00:00 2001 From: Fabian Posch Date: Fri, 5 Jan 2024 12:12:22 -0500 Subject: [PATCH] update readme --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 830c839..d8b8629 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,12 @@ # Actsim Cluster Agent -## Usage +Database frontend for the `actsim` simulator. This tool works in conjunction with `act-deploy` and its associated database. -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +If you want to run a lot of distributed simulations, this is how to do it. ## Roadmap -- [ ] Should be defined once the base implementation stands - -## Contributing - -- [ ] Should be written once the base implementation stands -- [ ] Add code styling guidelines +- [ ] Run simulations from the database ## Authors and acknowledgment