Skip to content

Commit

Permalink
docs: update readme (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
TomerAberbach authored Dec 8, 2024
1 parent fa8d593 commit 1fcd143
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,11 @@
</div>

<div align="center">
A TypeSpec emitter for fast-check arbitraries.
A TypeSpec emitter for
<a href="https://fast-check.dev"><code>fast-check</code></a>
arbitraries.
</div>

## Features

- **Wow:** so amazing
- **Amazing:** so wow
- **Fancy:** has a tie and everything

## Install

```sh
Expand All @@ -38,13 +34,23 @@ $ npm i typespec-fast-check

## Usage

```js
import tspFastCheck from 'typespec-fast-check'
Via the command line:

console.log(tspFastCheck())
//=> Hello World!
```sh
tsp compile . --emit=typespec-fast-check
```

Via the config:

```yaml
emit:
- 'typespec-fast-check'
```
See the
[TypeSpec documentation](https://typespec.io/docs/emitters/protobuf/reference/emitter)
for more information.
## Contributing
Stars are always welcome!
Expand All @@ -55,4 +61,4 @@ For bugs and feature requests,
## License
[MIT](https://github.com/TomerAberbach/typespec-fast-check/blob/main/license) ©
[Tomer Aberbach](https://github.com/TomerAberbach)
[Stainless Software, Inc.](https://www.stainlessapi.com)

0 comments on commit 1fcd143

Please sign in to comment.