Skip to content

Commit cba06f1

Browse files
committed
docs: what is this?
Signed-off-by: Lexus Drumgold <[email protected]>
1 parent 595c754 commit cba06f1

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
[![github release](https://img.shields.io/github/v/release/flex-development/estree-util-unassert.svg?include_prereleases&sort=semver)](https://github.com/flex-development/estree-util-unassert/releases/latest)
44
[![npm](https://img.shields.io/npm/v/@flex-development/estree-util-unassert.svg)](https://npmjs.com/package/@flex-development/estree-util-unassert)
5-
[![codecov](https://codecov.io/gh/flex-development/estree-util-unassert/graph/badge.svg?token=)](https://codecov.io/gh/flex-development/estree-util-unassert)
5+
[![codecov](https://codecov.io/gh/flex-development/estree-util-unassert/graph/badge.svg?token=qbrCLnCoJp)](https://codecov.io/gh/flex-development/estree-util-unassert)
66
[![module type: esm](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)
77
[![license](https://img.shields.io/github/license/flex-development/estree-util-unassert.svg)](LICENSE.md)
88
[![conventional commits](https://img.shields.io/badge/-conventional%20commits-fe5196?logo=conventional-commits&logoColor=ffffff)](https://conventionalcommits.org/)
99
[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript&logoColor=ffffff)](https://typescriptlang.org/)
1010
[![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)](https://vitest.dev/)
1111
[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff)](https://yarnpkg.com/)
1212

13-
[estree][estree] (and [esast][esast]) utility to remove assertions
13+
[estree][estree] (and [esast][esast]) utility to remove [assertions][assertion]
1414

1515
## Contents
1616

@@ -24,7 +24,7 @@
2424

2525
## What is this?
2626

27-
**TODO**: what is this?
27+
This package is a utility that replaces and removes assertions in JavaScript syntax trees.
2828

2929
## When should I use this?
3030

@@ -77,6 +77,7 @@ This package is fully typed with [TypeScript][typescript].
7777

7878
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
7979

80+
[assertion]: https://en.wikipedia.org/wiki/Assertion_(software_development)
8081
[esast]: https://github.com/syntax-tree/esast
8182
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
8283
[esmsh]: https://esm.sh/

0 commit comments

Comments
 (0)