diff --git a/README.md b/README.md index 6dc0efd..a430f94 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # nodegistry Docker Registry Remote API module. + +## Example +Get the manifest of an image stored on a private registry. +```javascript +const Registry = require('nodegistry'); + +let registry = new Registry({ + credentials: { + user: 'yourUsername', + pass: 'yourPassword' + }, + url: 'https://repository.yourcompany.com/v2', +}); + +let manifest = await registry.getRepository('mariadb').getManifest('10'); +console.log(manifest._body); + +```