From 8a848167f08fb7b20654462bf6e8ec8f4d5b6697 Mon Sep 17 00:00:00 2001 From: Jan Kuri Date: Tue, 31 Jul 2018 00:26:15 +0200 Subject: [PATCH] docs(readme): add README --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bd106a4 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# sharebox + +Sharebox is a web file manager application. Its intent is to share files quickly from your host +machine to local network or over the internet with minimal or zero configuration. It comes bundled in a single executable file. + +For sharing over the internet, it has included [vex](https://github.com/bleenco/vex) client, so you don't need to worry about firewall or NAT which is configured on your local network. + +## Usage + +### Sharing specific folder + +```sh +sharebox -dir /home/bleenco/Videos +``` + +### Help + +For complete command line usage, please see + +```sh +sharebox --help +``` + +## License + +> The MIT License +> +> Copyright (c) 2018 Bleenco GmbH https://bleenco.com +> +> 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.