From a841f05363d95682abf02ec3c4fca4fd1a43ad01 Mon Sep 17 00:00:00 2001
From: KeeganForelight <Keegan@forelight.com>
Date: Mon, 23 May 2022 19:51:00 -0400
Subject: [PATCH] updated README

---
 .README.md.swp | Bin 0 -> 12288 bytes
 README.md      |  26 ++++++++++++++++++++++++++
 2 files changed, 26 insertions(+)
 create mode 100644 .README.md.swp

diff --git a/.README.md.swp b/.README.md.swp
new file mode 100644
index 0000000000000000000000000000000000000000..f70ff0f306ca25ad982bf889cbdf429a47fa238c
GIT binary patch
literal 12288
zcmeI2Pixdb7{;f1Q>&sL6-JkW7IwQ;grcXaTM@e0ZflRiB$;G~PBL+3(z@W^qu|vK
z;OEezegV;wC%=OiZ$6XFZcCwh>80=n9wyn$yzle=-pOG}qVCqCK40oAG92d_`*!7h
z^y}Fy>&-E?oyfA3;l{s@)#bI#$7}80`rvl&-qzsI$*;x%7gh%SjfFvP`9Z(e$&*8;
z(+wg(1dfV8<<s`kEW34cu^U3Ru3hC9FFZM_=oE(t5CI}U1c(3;AOb{y2oQl|K){zX
z>@|FzXuMu-#+d_Sb4ddcAOb{y2oM1xKm>>Y5g-CYfCvx)B5(`|2)uv)eVVa1XJ8)h
z|0n<d|D0p&2lO5K41Iz=LLZ=a&`anAG=SEj`_Lum=UK*bNJCGdQ_$C0#uRiHx&yVL
zlh7CBd<)gNk0Cp<OazDk5g-CYfCvx)B0vO)!2bzw9BsZ43oSX@f1!$0IB%=iS5|Uw
zxJ*+OD_M9w;;t%7V?7teh_|>&xs@XJ#=0iNLu;yX`XkpSQ^<gYR%XH`S~?e2mBWz>
zH!vX<UYVj<zMLcoo$$&@?quPN<)w(XMJ62=p6@EHS*z8mZHq|bv*@w&#cp?wSEX0E
ztk*j!@;X;lCc<O!{CsAFZf1+hn;dE5;1AAXvm@=OUf7hw)2fJrFI8kbk*-u8hN`IT
zM$XHe!&f2wuCd!Z6-oot1b`cwN+-OuW=AEmP7n%$3lRxa6&s6$z6c<8lt5J`hmqLi
zx$*~s916Qm8mwJcMXakNoKE~$sZnt<^>w2LHjqNAJz`^Op_3v~TKQ4klnH6oksTh3
zg1cQ&POYPHHZb6-;6Um_(rI&2+{<NdfH9PraEDESwl%~XDiOMau7yn%4@HsHO!tBy
zuyO|W_cp}Fn0K>&KafeMVpF6ltBYLG^0`7i*cO{Z1K6bnA5~%}@T>~$FqIAMR9OK7
zM#X3wYo3A{4$cR%0fqB%K*YnA>kHUx*6zhcrm*KwP$qpCqDr~YT*g+6m8&WndW5W>
U5rim!B*&A)$91t551-+)zg+TN-T(jq

literal 0
HcmV?d00001

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
+