docs: update package description [skip ci]

This commit is contained in:
Liyas Thomas
2023-02-08 18:50:32 +05:30
parent 99918ee0c0
commit 536c8128dd
2 changed files with 26 additions and 22 deletions

View File

@@ -1,4 +1,17 @@
# Hoppscotch CLI <sup>ALPHA</sup> <div align="center">
<a href="https://hoppscotch.io">
<img
src="https://avatars.githubusercontent.com/u/56705483"
alt="Hoppscotch Logo"
height="64"
/>
</a>
</div>
<div align="center">
# Hoppscotch CLI <font size=2><sup>ALPHA</sup></font>
</div>
A CLI to run Hoppscotch test scripts in CI environments. A CLI to run Hoppscotch test scripts in CI environments.
@@ -33,7 +46,7 @@ hopp [options or commands] arguments
#### Options: #### Options:
##### `-e <file_path>` / `--env <file_path>` ##### `-e <file_path>` / `--env <file_path>`
- Accepts path to env.json with contents in below format: - Accepts path to env.json with contents in below format:
```json ```json
{ {
"ENV1":"value1", "ENV1":"value1",
@@ -41,7 +54,7 @@ hopp [options or commands] arguments
} }
``` ```
- You can now access those variables using `pw.env.get('<var_name>')` - You can now access those variables using `pw.env.get('<var_name>')`
Taking the above example, `pw.env.get("ENV1")` will return `"value1"` Taking the above example, `pw.env.get("ENV1")` will return `"value1"`
## Install ## Install

View File

@@ -1,24 +1,15 @@
<div align="center"> <div align="center">
<a href="https://hoppscotch.io">
<a href="https://hoppscotch.io"> <img
src="https://avatars.githubusercontent.com/u/56705483"
<img alt="Hoppscotch Logo"
height="64"
src="https://avatars.githubusercontent.com/u/56705483" />
</a>
alt="Hoppscotch Logo"
height="64"
/>
</a>
</div> </div>
<div align="center">
<div align="center"> # Hoppscotch UI <font size=2><sup>ALPHA</sup></font>
# Hoppscotch UI
</div> </div>