Update README.md

README.md

@@ -0,0 +1,44 @@
+nsync
+=============
+nsync is an easy to use bash command-line tool to backup your files to NSA's fully secure and free backup servers.
+
+How to backup data
+-------------
+Backing up data is very simple. Just run `./nsync.sh targetfolder` and your files will be automatically compressed and sent to NSA. Currently the backup endpoint is set to NSA's public affairs office. In reality the endpoint does not matter. Changing it to your mom's email address won't affect the backup process.
+
+How to restore your data
+-------------
+NSA came up with a simple 3 step process to restore your backups.
+
+1. Run for president of the United States
+2. Get elected
+3. Retrieve backup
+
+Know issues
+-------------
+##### I received an error message that my email size is exceeding the allowed limit
+Don't worry. Due to technical restrictions with legacy email systems this error might be raised when you send very large backups. You can safely ignore this message since your files got stored before they hit the actual mail server.
+
+License
+-------------
+The MIT License (MIT)
+
+Copyright (c) 2013 Marian Zange
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.