From d2342ea186e24475c2a312f44c95e3432ce0924f Mon Sep 17 00:00:00 2001 From: Ivan de la Beldad Fernandez Date: Sat, 16 Jun 2018 19:36:34 +0200 Subject: [PATCH] docs(core): add LICENSE and README --- LICENSE | 21 +++++++++++++++++++++ README.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..434164c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Ivan de la Beldad Fernandez + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0c2f387 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Media Server + +## Usage + +``` +Start o stop the desired user media server + +Commands: + start username basePort storage + stop username + +Arguments: + username Name of the user owner of the media server + basePort Number between 10 and 99 used as port prefix + storage Path where all will be stored + +Example: + sudo mediaserver ivandelabeldad 42 /media + + Storage: + /media/ivandelabeldad + Ports: + Plex 4200 + Tranmission 4201 + Sonarr 4202 + Radarr 4203 + Jackett 4204 +``` + +## License + +Media Server is open-sourced software licensed under +the [MIT license](https://github.com/ivandelabeldad/media-server/blob/master/LICENSE).