diff --git a/.README.md.swp b/.README.md.swp new file mode 100644 index 0000000..f70ff0f Binary files /dev/null and b/.README.md.swp differ diff --git a/README.md b/README.md index d7beb4c..4a29dfd 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # FRMS ForeLight Reactor Management System + +Time to get to buisness + +## Main design principles + - Flexible + - Reliable + - Scalable + +Those principles guide our design choices + +### Flexibile + - System should support any reactor config + - should be able to change sub packages in isolation + - portability of packages i.e. can swap databases or sub in testing packages for memory based storage + +### Realiable + - should support any # of reactors failing (including network related failures) + - should provide log and database correctness via atomic commits + - automatic log recovery and reactor functioning despite sub-system or network failures + - 100% uptime and seamless updates **goal + +### Scalable + - Add and use sensor packages at will + - Group reactors logically regardless of physical location + - Scale infastructure to efficiently support any # of reactors +