Skip to content

Commit

Permalink
docs: what is this?
Browse files Browse the repository at this point in the history
Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
  • Loading branch information
unicornware committed Mar 3, 2024
1 parent 595c754 commit cba06f1
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

[![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)
[![npm](https://img.shields.io/npm/v/@flex-development/estree-util-unassert.svg)](https://npmjs.com/package/@flex-development/estree-util-unassert)
[![codecov](https://codecov.io/gh/flex-development/estree-util-unassert/graph/badge.svg?token=)](https://codecov.io/gh/flex-development/estree-util-unassert)
[![codecov](https://codecov.io/gh/flex-development/estree-util-unassert/graph/badge.svg?token=qbrCLnCoJp)](https://codecov.io/gh/flex-development/estree-util-unassert)
[![module type: esm](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)
[![license](https://img.shields.io/github/license/flex-development/estree-util-unassert.svg)](LICENSE.md)
[![conventional commits](https://img.shields.io/badge/-conventional%20commits-fe5196?logo=conventional-commits&logoColor=ffffff)](https://conventionalcommits.org/)
[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript&logoColor=ffffff)](https://typescriptlang.org/)
[![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)](https://vitest.dev/)
[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff)](https://yarnpkg.com/)

[estree][estree] (and [esast][esast]) utility to remove assertions
[estree][estree] (and [esast][esast]) utility to remove [assertions][assertion]

## Contents

Expand All @@ -24,7 +24,7 @@

## What is this?

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

## When should I use this?

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

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

[assertion]: https://en.wikipedia.org/wiki/Assertion_(software_development)
[esast]: https://github.com/syntax-tree/esast
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh/
Expand Down

0 comments on commit cba06f1

Please sign in to comment.