diff --git a/README.md b/README.md index 4667259..46b5b0f 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,20 @@ A comprehensive solution for encrypted data storage. -# Features +# Running -- Simple Key -> Value storage -- Username / password logins -- Files / Directories +To get up and running, clone this repository, and open a terminal in the directory containing the `pom.xml` file. Run the following maven command: + +``` +mvn javafx:run +``` + +You can also use the `javafx-maven-plugin` to generate an executable using `mvn javafx:jlink`. # Design CrystalKeep makes use of _Shards_ as the most basic form of encrypted data storage. A shard is a single data item, like login credentials, an image, or some text. One or more shards are stored in a _Cluster_, which is essentially a collection of shards (and possibly nested clusters). Top-level clusters (not nested inside another) can be encrypted and saved with a secret key passphrase. -With this approach, the user minimizes the amount of data that is accessible to an attacker in the event that the attacker gets access to the system while the contents of a cluster are unencrypted in memory, since only one cluster may be actively open at a time. \ No newline at end of file +With this approach, the user minimizes the amount of data that is accessible to an attacker in the event that the attacker gets access to the system while the contents of a cluster are unencrypted in memory, since only one cluster may be actively open at a time. + +Furthermore, by removing a dependency on the host filesystem for encryption of, for example, files or directories, this solution is guaranteed to be equally secure across all platforms that it can run on. \ No newline at end of file diff --git a/pom.xml b/pom.xml index fc232a0..5fa2bc0 100644 --- a/pom.xml +++ b/pom.xml @@ -24,7 +24,11 @@ 0.0.4 nl.andrewlalis.crystalkeep.CrystalKeep - crystalkeep.exe + true + true + 2 + true + crystalkeep