Skip to content

Commit

Permalink
added readme and license files (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
MitchellBerend authored Oct 16, 2022
1 parent f3cc8db commit 02dddfb
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
## Added

[[#11](https://github.com/MitchellBerend/docker-manager/issues/11)]Implement images command and all its flags

[[#11](https://github.com/MitchellBerend/docker-manager/issues/11)] Implement images command and all its flags
[[#17](https://github.com/MitchellBerend/docker-manager/pull/17)] Added shell completion generation
[[#18](https://github.com/MitchellBerend/docker-manager/pull/18)] Added readme and license


v0.0.3
Expand Down
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2022 Mitchell Berendhuysen

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.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Quick start

1. Download the latests [release](https://github.com/MitchellBerend/docker-manager/releases).
2. Ensure the user you log in with has sudo rights.
3. Run `docker-manager completion --help` to set up auto completion for your
shell
4. Run `docker-manager ps`

# Goals
This project aims to have an easier way to interact with docker containers on
remote nodes from the comfort of your own terminal. The aim for this project is
to support all docker commands on remote nodes.

0 comments on commit 02dddfb

Please sign in to comment.