diff --git a/README.md b/README.md index 0ceaa4d..eea49bc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Fleet +**This project is still very much a work in progress, and should in no way be considered final.** + Fleet is a Docker Hub repository and image management tool for organisations (or individuals) who wish to display a list of all currently available images, along with their latest version and build status. The idea for this application was borne out of a necessity for the LinuxServer team to be able to provide a mechanism for its users to see the current build version of the images they use. Image information is retrieved via the Docker Hub API (v2) through a scheduled task, which runs at a given (configurable) interval. This task will synchronise all repositories owned by the user whose credentials are used to authorise the initial requests to Docker Hub. Fleet will store in memory a valid authorisation token and will reuse it until it expires, after which a new token will be requested.