Skip to content

Commit a8700f1

Browse files
committed
Update documentation to include '-start' argument
1 parent 826389d commit a8700f1

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
11
![dynamic-cli](https://socialify.git.ci/IndianOpenSourceFoundation/dynamic-cli/image?description=1&descriptionEditable=A%20Modern%2C%20user-friendly%20command-line%20%20for%20the%20API%20testing%2C%20and%20if%20you%27re%20stuck%20-%20Search%20and%20browse%20StackOverflow%20without%20leaving%20the%20CLI&font=Inter&forks=1&issues=1&language=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Light)
22

3-
4-
53
## Setup
64

75
**1.** Installing pip [Python Package Manager]
8-
```shell
6+
7+
```shell
98
$ sudo apt-get install python3-pip
109
```
1110

1211
**2.** Clone this repository to your local drive
13-
```shell
12+
13+
```shell
1414
$ git clone https://github.com/IndianOpenSourceFoundation/dynamic-cli.git
1515
```
1616

17-
**3.** Install dependencies
18-
```shell
17+
**3.** Install dependencies
18+
19+
```shell
1920
$ pip3 install -r requirements.txt
2021
```
2122

2223
**4.** Install with pip
23-
```shell
24+
25+
```shell
2426
$ pip3 install -e .
2527
```
2628

@@ -31,26 +33,26 @@ Dynamic CLI allows users to search for keywords/issues with some relevant tags.
3133
![ezgif com-gif-maker (1)](https://user-images.githubusercontent.com/49693160/111326116-4bcceb00-8692-11eb-9d3a-51350a006d34.gif)
3234

3335
## Arguments
36+
3437
Usage: Dynamic [OPTIONS] <br>
3538

3639
A Modern, user-friendly command-line HTTP client for the API testing, and if you're stuck - Search and browse StackOverflow without leaving the CLI. <br>
3740

3841
Options: <br>
3942

43+
`-start -> Introduces Dynamic CLI` <br>
4044
`-v, --version -> Gives the Version of the CLI` <br>
4145
`-s, --search -> Search a question on Stackoverflow` <br>
4246
`-d, --debug -> Turn on Debugging mode` <br>
4347
`-h, --help -> Shows this message and exit` <br>
4448

45-
4649
## License
4750

48-
4951
### Contributing
5052

5153
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat&logo=git&logoColor=white)](https://github.com/IndianOpenSourceFoundation/dynamic-cli/pulls) [![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/IndianOpenSourceFoundation/dynamic-cli)
5254

53-
**We're accepting PRs for our open and unassigned [issues](https://github.com/IndianOpenSourceFoundation/dynamic-cli/issues)**. Please check [CONTRIBUTING.md](CONTRIBUTING.md). We'd love your contributions! **Kindly follow the steps below to get started:**
55+
**We're accepting PRs for our open and unassigned [issues](https://github.com/IndianOpenSourceFoundation/dynamic-cli/issues)**. Please check [CONTRIBUTING.md](CONTRIBUTING.md). We'd love your contributions! **Kindly follow the steps below to get started:**
5456

5557
**1.** Fork [this](https://github.com/IndianOpenSourceFoundation/dynamic-cli) repository.
5658

@@ -89,6 +91,7 @@ git push
8991
**9.** **Congratulations!** Sit and relax, you've made your contribution to Dynamic-CLI project.
9092

9193
## Contributors:
94+
9295
### Credit goes to these people:✨
9396

9497
<table>

0 commit comments

Comments
 (0)