-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
John Schellinger
committed
Aug 19, 2024
1 parent
5b6cd2d
commit fe39bad
Showing
7 changed files
with
72 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| <p align="center" style="background: url(public/mc-dirt-banner.webp); padding: 2rem"> | ||
| <img src="./public/logo-sm.png" width="260" alt="EZMC Logo" /> | ||
| <p align="center" style="background: url(docs/images/mc-dirt-banner.webp); padding: 2rem"> | ||
| <img src="./docs/images/logo-sm.png" width="260" alt="EZMC Logo" /> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
|
|
@@ -88,23 +88,16 @@ Pull requests are welcomed. Please leave detailed reasoning for your change. Bug | |
| ### Development | ||
|
|
||
| ```sh | ||
| # clone the repo | ||
| git clone [email protected]:jseashell/ezmc-cli.git | ||
| npm install | ||
| # build the project and deploy to global installs | ||
| npm run build | ||
| chmod +x bin/* | ||
| node bin/index.js ls | ||
| # optional, use like a normal global package | ||
| npm link | ||
| # verify with | ||
| ezmc ls | ||
| ``` | ||
|
|
||
| ### Testing | ||
|
|
||
| ```sh | ||
| # run tests | ||
| npm test | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| This project is distributed under the terms of the [MIT License](./LICENSE). | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,7 +32,7 @@ | |
| flex-direction: column; | ||
| align-items: center; | ||
| padding: 4rem 0 1rem 0; | ||
| background: url('../public/mc-dirt-banner.webp'); | ||
| background: url('./images/mc-dirt-banner.webp'); | ||
| } | ||
|
|
||
| header img { | ||
|
|
@@ -46,6 +46,7 @@ | |
| display: flex; | ||
| flex-direction: column; | ||
| align-items: flex-start; | ||
| padding-bottom: 5rem; | ||
| } | ||
|
|
||
| div.badges { | ||
|
|
@@ -68,12 +69,6 @@ | |
| color: #ae7848; | ||
| } | ||
|
|
||
| img.terminal { | ||
| width: 100%; | ||
| height: auto; | ||
| padding: 2rem 0; | ||
| } | ||
|
|
||
| ul { | ||
| padding: 0; | ||
| } | ||
|
|
@@ -104,10 +99,9 @@ | |
| color: #794625; | ||
| } | ||
|
|
||
| ul.toc > li:nth-child(2) { | ||
| padding-top: 1.5rem; | ||
| ul.toc li ul { | ||
| padding: 0 2rem; | ||
| } | ||
|
|
||
| ul.toc li ul li { | ||
| margin: 0.25rem; | ||
| } | ||
|
|
@@ -142,33 +136,59 @@ | |
| font-size: 16px; | ||
| } | ||
|
|
||
| section img { | ||
| width: 100%; | ||
| height: auto; | ||
| padding: 2rem 0; | ||
| } | ||
|
|
||
| section > ul, | ||
| section > p, | ||
| section > div { | ||
| section > div, | ||
| section > img { | ||
| padding: 0 2.5rem !important; | ||
| } | ||
|
|
||
| div.disclaimer { | ||
| background-color: #2f2f2f; | ||
| color: #555555; | ||
| font-style: italic; | ||
| margin-left: 2rem; | ||
| margin-left: 1rem; | ||
| padding: 0.5rem; | ||
| width: calc(100% - 5rem); | ||
| width: calc(100%); | ||
| } | ||
|
|
||
| div.disclaimer p { | ||
| border-left: 1px solid #555555; | ||
| padding: 0.5rem; | ||
| } | ||
|
|
||
| #back-to-top { | ||
| opacity: 0; | ||
| transition: opacity 0.3s ease-in-out; | ||
| } | ||
| </style> | ||
|
|
||
| <script> | ||
| document.addEventListener('scroll', function () { | ||
| const fadeInElement = document.getElementById('back-to-top'); | ||
| const scrollPosition = window.scrollY; | ||
| const triggerPoint = 200; // Adjust this value to the desired scroll position | ||
|
|
||
| if (scrollPosition > triggerPoint) { | ||
| fadeInElement.style.opacity = 1; | ||
| } else { | ||
| fadeInElement.style.opacity = 0; | ||
| } | ||
| }); | ||
| </script> | ||
|
|
||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/index.min.css" /> | ||
| <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons" /> | ||
| </head> | ||
| <body> | ||
| <header id="top"> | ||
| <img src="../public/logo-sm.png" width="320" height="103" alt="EZMC Logo" /> | ||
| <img src="./images/logo-sm.png" width="320" height="103" alt="EZMC Logo" /> | ||
| <div class="badges"> | ||
| <img src="https://github.com/jseashell/ezmc-cli/actions/workflows/build.yml/badge.svg" alt="Build badge" /> | ||
| <img | ||
|
|
@@ -200,8 +220,9 @@ <h1>A server management CLI for self-hosting Minecraft Java Edition with AWS Ela | |
| <a href="https://github.com/itzg/docker-minecraft-server">itzg/docker-minecraft-server</a> Docker image in AWS | ||
| ECS. | ||
| </p> | ||
| <img class="terminal" src="../public/terminal.png" alt="Terminal example" /> | ||
|
|
||
| <section> | ||
| <img class="terminal" src="./images/usage.png" alt="Terminal example" /> | ||
| </section> | ||
| <section> | ||
| <h3 id="features">Features</h3> | ||
| <ul> | ||
|
|
@@ -302,38 +323,41 @@ <h4>Pull Requests</h4> | |
| <a href="https://github.com/tj/commander.js">commander.js</a> | ||
| manage cross-platform compatibility. | ||
| </p> | ||
| <h4>Development</h4> | ||
| <img src="./images/development.png" alt="Development example" /> | ||
| </section> | ||
| <section> | ||
| <h3 id="license">License</h3> | ||
| <p> MIT License </p> <p> Copyright (c) 2024 John Schellinger </p> | ||
| <p> | ||
| 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: | ||
| </p> | ||
| <p> | ||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions | ||
| of the Software. | ||
| </p> | ||
| <p> | ||
| 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. | ||
| </p> | ||
| <details> | ||
| <summary>This software is distributed under the terms of the MIT License</summary> | ||
| <p>MIT License</p> | ||
| <p> Copyright (c) 2024 John Schellinger </p> | ||
| <p> | ||
| 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: | ||
| </p> | ||
| <p> | ||
| The above copyright notice and this permission notice shall be included in all copies or substantial | ||
| portions of the Software. | ||
| </p> | ||
| <p> | ||
| 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. | ||
| </p> | ||
| </details> | ||
| </section> | ||
| </main> | ||
| <ul class="toc"> | ||
| <li class="back-to-top"> | ||
| <a href="#top"><i class="material-icons">arrow_upward</i>Back to top</a></li | ||
| > | ||
| <li><a href="#features">Features</a></li> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li | ||
| ><a href="#commands">Commands</a> | ||
| <li> | ||
| <a href="#commands">Commands</a> | ||
| <ul> | ||
| <li> | ||
| <a href="#cip"><code>cip</code></a> | ||
|
|
@@ -367,6 +391,9 @@ <h3 id="license">License</h3> | |
| <li><a href="#infrastructure">Infrastructure</a></li> | ||
| <li><a href="#contributing">Contributing</a></li> | ||
| <li><a href="#license">License</a></li> | ||
| <li id="back-to-top" class="back-to-top"> | ||
| <a href="#top"><i class="material-icons">arrow_upward</i>Back to top</a> | ||
| </li> | ||
| </ul> | ||
| </body> | ||
| </html> | ||
Binary file not shown.