docs: Add license and comments

Author: KEINOS

.github/workflows/azure_scan.yml

@@ -7,6 +7,7 @@ on:
   pull_request:
     branches: [ master ]
   schedule:
+    # Runs at 00:45 UTC on Sunday (JST: AM 05:45 on every Monday)
     - cron: '45 0 * * 0'
 
 jobs:

.github/workflows/snyk_scan.yml

@@ -5,9 +5,9 @@ on:
   push:
     branches: [ master ]
   pull_request:
-    # The branches below must be a subset of the branches above
     branches: [ master ]
   schedule:
+    # Runs at 00:45 UTC on Sunday (JST: AM 05:45 on every Monday)
     - cron: '45 0 * * 0'
 
 permissions:

.github/workflows/weekly-update.yml

@@ -1,14 +1,17 @@
 # =============================================================================
-#  Weekly Module Update
+#  Weekly Version Check To Update
 # =============================================================================
-# This workflow runs weekly to update and test the latest `go.mod` version.
+# This workflow runs weekly, builds the latest SQLite source code and updates
+# the version file.
 #
-# If all the tests succeeds to run in all Go versions, it will create a new PR
-# of the `go.mod` and `go.sum`.
+# If all tests are successful and the SQLite version has changed, a new Pull
+# Request is created to update the version file.
 #
 # NOTE:
 # You need to set the `PERSONAL_ACCESS_TOKEN` environment variable in the repo's
+# settings at GitHub:
 #     [Settings]-[Secrets]-[Actions secrets]
+#
 # To generate a new token go to:
 #     https://github.com/settings/tokens
 #     * You need add the "repo" scope to the token but no more.

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-2022 KEINOS and the Contributors (https://github.com/KEINOS/Dockerfile_of_SQLite3/graphs/contributors)
+
+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

@@ -3,36 +3,29 @@
 
 # Dockerfile of SQLite3
 
-Docker image of the latest SQLite3 version.
+Alpine Docker image of SQLite3 built from the latest source code.
 
-- Pull the latest build: `docker pull keinos/sqlite3:latest`
-- Pull the version tagged build: `docker pull keinos/sqlite3:3.38.2`
-  - [Available tags](https://hub.docker.com/r/keinos/sqlite3/tags) @ DockerHub
-
-<details><summary>Build it locally</summary>
-
-```shellsession
-$ git clone https://github.com/KEINOS/Dockerfile_of_SQLite3.git
-$ cd Dockerfile_of_SQLite3
-$ docker build -t keinos/sqlite3:latest .
-...
+```bash
+docker pull keinos/sqlite3:latest
 ```
 
-</details>
+- [View Available Tags (SQLite version)](https://hub.docker.com/r/keinos/sqlite3/tags) @ DockerHub
+- Current SQLite3 version: [VERSION_SQLite3.txt](https://github.com/KEINOS/Dockerfile_of_SQLite3/blob/master/VERSION_SQLite3.txt)
 
-<details><summary>Image and Repository Info</summary>
+<details><summary>Image Information (Dockerfile, Security Scan, etc.)</summary>
 
-- Current SQLite3 version: [VERSION_SQLite3.txt](https://github.com/KEINOS/Dockerfile_of_SQLite3/blob/master/VERSION_SQLite3.txt)
-- Repositories:
-  - Image: https://hub.docker.com/r/keinos/sqlite3 @ DockerHub
-  - Dockerfile: https://github.com/KEINOS/Dockerfile_of_SQLite3 @ GitHub
-- Issues: https://github.com/KEINOS/Dockerfile_of_SQLite3/issues @ GitHub
+- Repositories/Registries:
+  - [Image Registry](https://hub.docker.com/r/keinos/sqlite3)  @ DockerHub
+  - [Dockerfile](https://github.com/KEINOS/Dockerfile_of_SQLite3/blob/master/Dockerfile) @ GitHub
+  - [Issues](https://github.com/KEINOS/Dockerfile_of_SQLite3/issues) @ GitHub
 - Build Info:
   - Base Image: `alpine:latest`
   - SQLite3 Source: [https://www.sqlite.org/src/](https://www.sqlite.org/src/doc/trunk/README.md) @ SQLite.org
-  - Basic Vulnerability Scan:
-    - Snyk and Azure Container Scan.
-    - See the [Security overview](https://github.com/KEINOS/Dockerfile_of_SQLite3/security) for the details.
+  - Update Interval: [Once a week](https://github.com/KEINOS/Dockerfile_of_SQLite3/blob/master/.github/workflows/weekly-update.yml)
+- Basic Vulnerability Scan:
+  - [Snyk Docker Scan](https://github.com/KEINOS/Dockerfile_of_SQLite3/blob/master/.github/workflows/snyk_scan.yml) and [Azure Container Scan](https://github.com/KEINOS/Dockerfile_of_SQLite3/blob/master/.github/workflows/azure_scan.yml) on push, PR and merge.
+  - Scan Interval: Once a week.
+  - See the [Security overview](https://github.com/KEINOS/Dockerfile_of_SQLite3/security) for the details.
 
 </details>
 
@@ -47,6 +40,15 @@ $ docker pull keinos/sqlite3:latest
 ...
 ```
 
+Or, you can build the latest image locally as below:
+
+```shellsession
+$ git clone https://github.com/KEINOS/Dockerfile_of_SQLite3.git
+$ cd Dockerfile_of_SQLite3
+$ docker build -t keinos/sqlite3:latest .
+...
+```
+
 ### Interactive
 
 Running `sqlite3` command inside the container interactively.
@@ -86,3 +88,14 @@ $ docker run --rm keinos/sqlite3 /run-test.sh
 $ echo $?
 0
 ```
+
+[Let us know](https://github.com/KEINOS/Dockerfile_of_SQLite3/issues) if you have any test to be included.
+
+## TODO
+
+- [ ] ARM support for DockerHub ([Issue #2](https://github.com/KEINOS/Dockerfile_of_SQLite3/issues/2))
+
+## License
+
+- [MIT License](https://github.com/KEINOS/Dockerfile_of_SQLite3/blob/master/LICENSE.md) by [The Dockerfile of SQLite3 Contributors](https://github.com/KEINOS/Dockerfile_of_SQLite3/graphs/contributors).
+  - SQLite: [Public Domain](https://sqlite.org/copyright.html) by [D. Richard Hipp](https://en.wikipedia.org/wiki/D._Richard_Hipp) and [SQLite.org](https://sqlite.org/).

check-updates.sh

@@ -5,14 +5,15 @@ help=$(
   This script updates the VERSION_SQLite3.txt and the Docker image.
 -----------------------------------------------------------------------------
  - Options:
+   --help  : Shows this help.
    --force : Force the update process even if the version is the same.
    --commit: Git commit the version changes.
    --push  : Push the image to Docker Hub. If `--commit` is set it will push
              the git commit to GitHub as well.
 
  - Notes:
-   - If there is no update, it exits with status 0.
-   - This script will `prune` the unused contaier and images.
+   - By default, if there are no updates, the script exits with status 0.
+   - This script removes ("prunes") unused containers and images.
 HEREDOC
 )