diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..59d6e4c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2020 Dawid Wysokiński + +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 index 864f70a..dec9ee6 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ -# tribalwarshelp.com \ No newline at end of file +# [version].tribalwarshelp.com + +![Screenshot](/screenshots/indexpage.png?raw=true) + +A stat tracking and tools website for the online game [Tribal Wars](https://tribalwars.net). + +## Development + +### Prerequisites + +1. Node.JS +2. yarn + +### Installation + +1. Clone this repo +``` +git clone git@github.com:tribalwarshelp/version.tribalwarshelp.com.git +``` +2. Navigate to the directory where you have cloned this repo. +3. ``yarn install`` +4. ``yarn run start`` + +## License + +Distributed under the MIT License. See ``LICENSE`` for more information. + +## Contact + +Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me) diff --git a/screenshots/indexpage.png b/screenshots/indexpage.png new file mode 100644 index 0000000..d1ae2f5 Binary files /dev/null and b/screenshots/indexpage.png differ