Skip to content

Commit 0e7781a

Browse files
authored
Update README.md
1 parent e6ac79a commit 0e7781a

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# EncryptorAppVS
21

3-
Master: [![Build status](https://ci.appveyor.com/api/projects/status/lspd6npm0sbwtscm?svg=true)](https://ci.appveyor.com/project/johnkellyoxford/encryptionapp)
2+
# EncryptorAppVS
43

54
## Documentation:
65

@@ -19,3 +18,17 @@ Master: [![Build status](https://ci.appveyor.com/api/projects/status/lspd6npm0sb
1918
## Updates
2019
* Add error handling if encryption/decryption fails
2120

21+
## Directories
22+
* `src` contains UI and logic. It is the `.exe`
23+
* `CryptoTools` contains the encryption tools. It is a `.dll` that can be used by other applications
24+
* `utils` contains mixed utilites
25+
* `UnitTests` are the tests for `src` and `CryptoTools`
26+
27+
## Branches
28+
* `master` is the branch the current stable release is built off
29+
* `release` is beta/nightly versions in testing
30+
* `dev` is working prototypes and for the majority of work
31+
* `experimental` is for large changes that may not be functional
32+
* `hotfix` is for quick changes to push to `master` or `release`
33+
34+
**Please use forks for your own work, and PR to the applicable branch**

0 commit comments

Comments
 (0)