Skip to content
This repository was archived by the owner on Feb 25, 2024. It is now read-only.

Commit e305762

Browse files
authored
Update README.md
1 parent 8a80f51 commit e305762

1 file changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
1-
# is-a-dev-cli
1+
# is-a.dev CLI
22
Register your own is-a.dev subdomain from your command line!
3+
4+
## Getting Started
5+
6+
Using the is-a.dev CLI is easy!
7+
8+
All you need to do is run the following command:
9+
10+
```bash
11+
npm install @is-a-dev/cli -g
12+
```
13+
14+
...and that's it!
15+
16+
## Using Commands
17+
18+
All of the CLI commands start with `is-a-dev`.
19+
20+
To show the help menu, in your terminal run this command:
21+
22+
```bash
23+
is-a-dev help
24+
```
25+
26+
### Debugging
27+
28+
If you are having issues using the CLI, follow these simple steps:
29+
30+
1. Run the debug command
31+
32+
```bash
33+
is-a-dev debug
34+
```
35+
36+
2. Open an issue
37+
38+
Open an issue stating your issue and provide the output from the debug command as well.

0 commit comments

Comments
 (0)