Files & Folders + started on pom.xml

README.md

@@ -1,3 +1,31 @@
 # BrickLog
 
-A Client application that interfaces with BrickLog-Server to store and manage Lego builds and MoC creations
+A Client application that interfaces with BrickLog-Server to store and manage Lego builds and MoC creations.
+
+The Client should be able to be used on linux and windows systems ass it will be Java based.
+
+The Server will be made Docker compatible and there may be other versions made as well (ie. no Docker needed)
+
+### Features:
+- A GUI (so youdon't have to use the command line or terminal)
+- Ability to quickly see your builds
+    - See who built them
+    - see whether it is a Kit or a MoC
+    - see details of the build (Piece count, Price, Link to the kit on Lego.com etc) [ this should be direct from the lego.com website ]
+    - browse a gallery of the build images
+    - builds and builders will be searchable (search: [ builderName123 ] will only show all builds that builderName123 has done)
+- A quick Server that stores all the information
+
+## [!WARNING]
+- There will not be a username / password to access the information from the Client.
+- There will be the neccassary auth on the server side to make sure that the databse is secure and only the Client can access the server's database.
+
+### Minimal Config Needed
+The following will be needed to make the connection to the server from the client:
+
+- The server's IP address (link) will need to be added to the relevant setting dialogue when the client starts
+
+## [!NOTE]
+You should be able to access the data and create / edit / delete records with just the above setup.
+
+        - N.B. There will eventually be a "dark" mode but this will be a while down the track and located in the Client -> Settings -> Client Theme option