Skip to content
This repository has been archived by the owner on Jan 8, 2024. It is now read-only.

Commit

Permalink
Merge pull request #80 from cisagov/bug/install
Browse files Browse the repository at this point in the history
reference correct entrypoint
  • Loading branch information
zenine07 committed May 20, 2021
2 parents f3420c6 + 09d5193 commit cdfd2e2
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 4 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,40 @@
# Domain Manager CLI
# Domain Manager CLI #

Domain Management Command Line Interface

## Contributing
## How to Install ##

You can install the Domain Manager CLI one of two ways.

Option 1 - Local Development

```bash
# Clone the repo
git clone https://github.com/cisagov/domain-manager-cli.git

# Install
pip install .

# Run
dmcli
```

Option 2 - General Usage

```bash
# Install directly from rep
pip install git+https://github.com/cisagov/domain-manager-cli.git

# Run
dmcli
```

## Contributing ##

We welcome contributions! Please see [here](CONTRIBUTING.md) for
details.

## License
## License ##

This project is in the worldwide [public domain](LICENSE).

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,5 +110,5 @@ def get_version(version_file):
]
},
# Conveniently allows one to run the CLI tool as `dmcli`
entry_points={"console_scripts": ["dmcli = main:start"]},
entry_points={"console_scripts": ["dmcli = dmcli.main:start"]},
)

0 comments on commit cdfd2e2

Please sign in to comment.