Skip to content

Commit 07eb3dd

Browse files
committed
Add licence and screenshot
1 parent c1893ff commit 07eb3dd

2 files changed

Lines changed: 29 additions & 4 deletions

File tree

LICENCE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Oliver Tappin
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ for DevOps, Site Reliability Engineers (SREs), and engineers who need to poke ar
55
environments, or microservices in cloud-based or containerized setups such as Kubernetes, Cloud Run, and other
66
serverless platforms.
77

8+
![Screenshot](https://github.com/user-attachments/assets/df3889de-178c-43c6-b140-79925ca27fa6)
9+
810
## Features
911

1012
- Access to a web-based terminal that mimics a typical command-line interface.
@@ -87,8 +89,10 @@ docker run -d -p 8089:80 --name cmd cmd
8789
This will stop the currently running container, rebuild the image, and start a new container.
8890

8991
### Contributions
90-
Feel free to fork this repository and submit pull requests. This tool is designed to help others, and contributions
91-
that improve functionality or add new features are always welcome.
9292

93-
### License
94-
This project is open source and licensed under the MIT License. See the LICENSE file for more information.
93+
Please open a GitHub issue for discussion before opening a pull-request.
94+
95+
Once created, create your branch in the following format: `{feature|hotfix}/{github-issue-number}` and open the
96+
relevant pull-request into the master branch for review.
97+
98+
All contributions, no matter how large or small, are welcome.

0 commit comments

Comments
 (0)