Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
docs: update README.md, change shell to sh

docs: update README.md

docs: update README.md
  • Loading branch information
nezutero committed Apr 17, 2024
1 parent 033a05c commit 1d7038e
Showing 1 changed file with 13 additions and 47 deletions.
60 changes: 13 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,46 @@
## url-probe
### that the tool is guarding or watching over URLs to ensure their availability and performance

###

<div align="center">
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/go/go-original.svg" height="200" alt="go logo" />
</div>

###


- a simple command-line tool in golang which is checking url health and performance
- provides a command-line interface for checking url health and performance

## project structure:

```go
.
├── core
│   ├── args.go
│   ├── core.go
│   └── reader.go
├── go.mod
├── go.sum
├── main.go
├── README.md
└── tests
├── args_test.go
├── core_test.go
├── probe_test.go
└── reader_test.go
```

## installation
## Installation

```shell
```sh
git clone https://github.com/kenjitheman/url-probe
```

## usage
## Usage

```
```sh
go build
```

- using command line arguments:
- Using command line arguments:

```sh
./url-probe https://example.com https://example2.com
```

- using csv as a source:
- Using csv as a source:

```sh
./url-probe -source=csv -file=urls.csv
```

- using json as a source:
- Using json as a source:

```sh
./url-probe -source=json -file=urls.json
```

- using txt as a source:
- Using txt as a source:

```sh
./url-probe -source=txt -file=urls.txt
```

## contributing
## Contributing

- pull requests are welcome, for major changes, please open an issue first to
discuss what you would like to change
- Pull requests are welcome, for major changes, please open an issue first to
discuss what you would like to change.

- please make sure to update tests as appropriate
- Please make sure to update tests as appropriate.

## license
## License

- [MIT](https://choosealicense.com/licenses/mit/)

0 comments on commit 1d7038e

Please sign in to comment.