Skip to content

Commit

Permalink
bump to 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mbund committed Jul 6, 2024
1 parent 9fb4db3 commit 821795c
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 17 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 32 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# healthscript

A [DSL](https://en.wikipedia.org/wiki/Domain-specific_language) for writing healthchecks.

![healthcheck example](https://healthscript.mbund.dev/https://example.com)
Expand Down Expand Up @@ -41,6 +39,38 @@ The general philosophy behind the language design are as follows:
- `[POST] <aHR0cHM6Ly9naXRodWIuY29tL3Job21idXNnZy9oZWFsdGhzY3JpcHQ=> https://httpbin.org/post`
- ![](https://healthscript.mbund.dev/[POST]<aHR0cHM6Ly9naXRodWIuY29tL3Job21idXNnZy9oZWFsdGhzY3JpcHQ=>%20https://httpbin.org/post)

## Error Recovery

The parser will recover from errors as best as possible to help you write correct healthscript. Errors are available using the CLI.

![error handling](./errors.png)

## Badge Service

Append healthscript at the end of `https://healthscript.mbund.dev/` to have the hosted server run the healthcheck against your service and generate an svg badge. Then, you can use markdown syntax to include it in your own readmes.

```
![healthcheck for example.com](https://healthscript.mbund.dev/https://example.com)
```

![healthcheck for example.com](https://healthscript.mbund.dev/https://example.com)

You may need to url encode your spaces to `%20`.

## Library

Integrate healthscript into your own rust project. To do so, add the following to your `Cargo.toml`

```
healthscript = "1.0"
```

Or use the `cargo` CLI.

```
cargo add healthscript
```

## TCP Examples

- Connect to `pwn.osucyber.club` on port `13389` over TCP, and expect at least one byte to be returned
Expand Down Expand Up @@ -76,15 +106,3 @@ The general philosophy behind the language design are as follows:

- `dns://example.com/1.1.1.1`
- ![](https://healthscript.mbund.dev/dns://example.com/1.1.1.1)

## Badge Service

Append healthscript at the end of `https://healthscript.mbund.dev/` to have the hosted server run the healthcheck against your service and generate an svg badge. Then, you can use markdown syntax to include it in your own readmes.

```
![healthcheck for example.com](https://healthscript.mbund.dev/https://example.com)
```

![healthcheck for example.com](https://healthscript.mbund.dev/https://example.com)

You may need to url encode your spaces to `%20`.
Binary file added errors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions healthscript/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "healthscript"
version = "0.1.0"
version = "1.0.0"
edition = "2021"

[dependencies]
Expand Down Expand Up @@ -30,4 +30,3 @@ yansi = "1.0.1"

[dev-dependencies]
expect-test = "1.5.0"

0 comments on commit 821795c

Please sign in to comment.