diff --git a/README.md b/README.md index afc8ead..0b0f9bd 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ # senzingapi-tools +## Synopsis + +A Docker image with Senzingapi library and Senzing tools installed. + ## Overview -The `senzing/senzingapi-tools` docker image is pre-installed with the Senzingapi library +The [senzing/senzingapi-tools] Docker image is pre-installed with the Senzingapi library and python tools to help simplify creating applications that use the Senzingapi library. ## Use -In a Dockerfile, the docker image created by this repo can be used in a Docker -file by setting it as the base image. +In your `Dockerfile`, set the base image to `senzing/senzingapi-tools`. +Example: ```Dockerfile FROM senzing/senzingapi-tools @@ -16,21 +20,20 @@ FROM senzing/senzingapi-tools ## License -View -[license information](https://senzing.com/end-user-license-agreement/) -for the software container in this Docker image. +View [license information] for the software container in this Docker image. Note that this license does not permit further distribution. -This Docker image may also contain software from the -[Senzing GitHub community](https://github.com/Senzing/) -under the -[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). +This Docker image may also contain software from the [Senzing GitHub community] +under the [Apache License 2.0]. + +Further, as with all Docker images, this likely also contains other software which may +be under other licenses (such as Bash, etc. from the base distribution, along with any direct +or indirect dependencies of the primary software being contained). -Further, as with all Docker images, -this likely also contains other software which may be under other licenses -(such as Bash, etc. from the base distribution, -along with any direct or indirect dependencies of the primary software being contained). +As for any pre-built image usage, it is the image user's responsibility to ensure that +any use of this image complies with any relevant licenses for all software contained within. -As for any pre-built image usage, -it is the image user's responsibility to ensure that any use of this image complies -with any relevant licenses for all software contained within. +[Apache License 2.0]: https://www.apache.org/licenses/LICENSE-2.0 +[license information]: https://senzing.com/end-user-license-agreement/ +[Senzing GitHub community]: https://github.com/Senzing/ +[senzing/senzingapi-tools]: https://hub.docker.com/r/senzing/senzingapi-tools