Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Description updates to remove deprecated commands #162

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 4 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Heroku Docker CLI plugin
# Heroku container tools CLI plugin

Heroku Toolbelt plugin to help configure, test and release apps to Heroku using Docker and Docker Compose.
Heroku Toolbelt plugin to push Docker images to the Heroku container registry.

## Installation

Expand All @@ -20,20 +20,8 @@ Usage: heroku container

Additional commands, type "heroku help COMMAND" for more details:

container:init # create Dockerfile and docker-compose.yml
container:release # create and release slug to app
```

For help with a particular command:

```
$ heroku help container:init
Usage: heroku container:init

-i, --image IMAGE # the Docker image from which to inherit
-f, --force # overwrite existing Dockerfile and docker-compose.yml

Creates a Dockerfile and docker-compose.yml for the app specified in app.json
container:login # Logs in to the Heroku container registry
container:push [PROCESS] # Builds, then pushes a Docker image to deploy your Heroku app
```

## Developing and contributing
Expand All @@ -46,8 +34,3 @@ $ cd heroku-container-tools
$ npm install
$ heroku plugins:link .
```

### Add-ons

The mapping from Heroku add-on specified in `app.json` to container configured in `docker-compose.yml` is tracked in `lib\app.json`.
The mapping currently includes a limited subset of add-ons that we have tested. We welcome additions in the form of PRs.
2 changes: 1 addition & 1 deletion commands/login.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ module.exports = function(topic) {
topic: topic,
command: 'login',
flags: [{ name: 'verbose', char: 'v', hasValue: false }],
description: 'Logs in to the Heroku Docker registry',
description: 'Logs in to the Heroku container registry',
needsApp: false,
needsAuth: true,
run: cli.command(co.wrap(login))
Expand Down