You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,27 @@ Support coming soon!
21
21
22
22
Support coming soon!
23
23
24
+
## Getting Started
25
+
26
+
`hit` works based on the config present in the current working directory. Specifically, the `.hit/config.json` file present in the current working directory. You can either build your config from scratch or generate one based on a swagger file.
27
+
28
+
### BYOC (Build Your Own Config)
29
+
30
+
Running `hit` in any directory would set up a basic hit config file. Follow the instructions and examples under the [Usage section](#Usage) to add in your commands.
31
+
32
+
### Swagger Import
33
+
34
+
If you have a swagger file or any other OpenAPI spec file documenting the API endpoints on your system, then you can generate hit config to work with those endpoints by running:
35
+
36
+
```
37
+
hit import <path to swagger file>
38
+
```
39
+
40
+
This command will generate the corresponding `.hit/config.json` file in the current working directory.
41
+
24
42
## Usage
25
43
26
-
`hit` works based on the config present in the current working directory. Specifically, the `.hit/config.json` file present in the current working directory. The contents of the config define what commands are available to run.
44
+
The contents of the config define what commands are available to run.
0 commit comments