Adding a planning document for future code refactor

1 files changed, 21 insertions, 0 deletions

diff --git a/PLANNING b/PLANNING
new file mode 100644
index 0000000..89d224f
--- /dev/null
+++ b/PLANNING
@@ -0,0 +1,21 @@
+Sugested module layout
+
+lib.rs        // Entry points and initialisation
+core.rs       // Handles all multi-threading and stuff
+
+vault/
+  mod.rs      // core code
+  fs.rs       // All filesystem utilities
+  
+record/
+  mod.rs      // core code
+  version.rs  // versioning utilities
+
+crypto/
+  mod.rs      // core code
+  encoding.rs // encoding utility functions
+
+api/
+  mod.rs       // ...
+  rest.rs      // A RESTful API
+  binding.rs   // Exports some C headers