From 430481929abb319464cf044c297ded090692e088 Mon Sep 17 00:00:00 2001 From: William Harrison Date: Tue, 21 Feb 2023 20:06:50 +0800 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 161e3e8..ab0875a 100644 --- a/README.md +++ b/README.md @@ -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.