Skip to content

Add an example to the README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dorianboulch wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add an example to the README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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);

```