Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wdhdev authored Feb 21, 2023
1 parent ad5faa4 commit 4304819
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,40 @@
# Open Domains CLI
Register free subdomains with Open Domains from your command line.

## Getting Started

Using the Open Domains CLI is easy!

All you need to do is run the following command:

```bash
npm install @open-domains/cli -g
```

...and that's it!

## Using Commands

All of the CLI commands start with `open-domains`.

> You can also use the alias `od` instead.
To show the help menu, in your terminal run this command:

```bash
open-domains help
```

### Debugging

If you are having issues using the CLI, follow these simple steps:

1. Run the debug command

```bash
open-domains debug
```

2. Open an issue

Open an issue stating your issue and provide the output from the debug command as well.

0 comments on commit 4304819

Please sign in to comment.