Merge pull request #1 from nafumie/whitesource/configure

Configure WhiteSource Bolt for GitHub

.whitesource

@@ -0,0 +1,12 @@
+{
+  "scanSettings": {
+    "baseBranches": []
+  },
+  "checkRunSettings": {
+    "vulnerableCheckRunConclusionLevel": "failure",
+    "displayMode": "diff"
+  },
+  "issueSettings": {
+    "minSeverityLevel": "LOW"
+  }
+}

README.md

@@ -1,2 +1,19 @@
 # winsudo
-A pretty stupid implementation of the sudo command in windows.
+`winsudo` is an otherwise dumb implementation of the linux command `sudo` in windows, built using C#. It's really stupid so please just think of it as a joke and not as an actual project.
+
+*NOTE: since the password thingy has not been implemented yet, please use the password `workinprogress`.*
+
+*SIDE NOTE: please don't actually use this for real world purposes.*
+
+### Limitations
+Due to limitations in Microsoft Windows, A UAC prompt will be required to start your `winsudo`'d application or argument. While you can get rid of this by turning off UAC, please don't unless you really know what you're doing.
+
+### Features
+Password Entry (work in progress)  
+The general feeling of the `sudo` command at your Windows CLI.
+
+### Compiling
+I have no idea how to write compiling instructions. Just compile it like any C program.
+
+### License
+This project is licensed under the MIT License, please read the `LICENSE` file for more information.