Update README.md

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jonas Kaninda
+
+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.

README.md

@@ -5,6 +5,12 @@ MySQL Backup tool, backup database to S3 or Object Storage
 ![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/jkaninda/mysql-bkup?style=flat-square)
 ![Docker Pulls](https://img.shields.io/docker/pulls/jkaninda/mysql-bkup?style=flat-square)
 
+<p align="center">
+  <a href="https://github.com/jkaninda/mysql-bkup">
+    <img src="https://www.mysql.com/common/logos/logo-mysql-170x115.png" alt="Logo">
+  </a>
+  </p>
+
 > Runs on:
 - Docker
 - Kubernetes
@@ -23,6 +29,12 @@ MySQL Backup tool, backup database to S3 or Object Storage
 - local
 - s3
 - Object storage
+
+## Volumes:
+
+- /s3mnt => S3 mounting path 
+- /backup => local storage mounting path
+
 ## Usage
 
 | Options       | Shorts | Usage                              |
@@ -313,4 +325,22 @@ spec:
               - name: S3_ENDPOINT
                 value: "https://s3.us-west-2.amazonaws.com"
           restartPolicy: Never
-```
+```
+
+## Contributing
+
+Contributions are welcome! If you encounter any issues or have suggestions for improvements, please create an issue or submit a pull request. 
+Make sure to follow the existing coding style and provide tests for your changes.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+## Authors
+
+**Jonas Kaninda**
+- <https://github.com/jkaninda>
+
+## Copyright
+
+Copyright (c) [2023] [Jonas Kaninda]

src/docker/Dockerfile

@@ -33,4 +33,5 @@ RUN ln -s /usr/local/bin/mysql_bkup.sh /usr/local/bin/mysql_bkup
 RUN ln -s /usr/local/bin/mysql_bkup.sh /usr/local/bin/bkup
 
 RUN mkdir /backup
-WORKDIR /backup
+WORKDIR /backup
+VOLUME /backup

src/mysql_bkup.sh

@@ -1,4 +1,11 @@
-#!/usr/bin/env bash 
+#!/usr/bin/env bash
+
+# MySQL Backup & Restore 
+
+# @author    Jonas Kaninda
+# @license   MIT License <https://opensource.org/licenses/MIT>
+# @link      https://github.com/jkaninda/mysql-bkup
+#
 set -e
 TIME=$(date +%Y%m%d_%H%M%S)
 MY_SQL_DUMP=/usr/bin/mysqldump