Skip to content

Commit

Permalink
docs: correct typemod references
Browse files Browse the repository at this point in the history
  • Loading branch information
JounQin committed Oct 10, 2021
1 parent 416be62 commit 2ea1301
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"changelog": [
"@changesets/changelog-github",
{
"repo": "rx-ts/lib-boilerplate"
"repo": "rx-ts/typemod"
}
],
"commit": false,
Expand Down
5 changes: 5 additions & 0 deletions .changeset/purple-dragons-shop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'typemod': patch
---

docs: correct typemod references
46 changes: 26 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# lib-boilerplate
# typemod

[![GitHub Actions](https://github.com/rx-ts/lib-boilerplate/workflows/CI/badge.svg)](https://github.com/rx-ts/lib-boilerplate/actions/workflows/ci.yml)
[![Codecov](https://img.shields.io/codecov/c/github/rx-ts/lib-boilerplate.svg)](https://codecov.io/gh/rx-ts/lib-boilerplate)
[![Codacy Grade](https://img.shields.io/codacy/grade/f2cec506ecf446aca3769c402e0a104e)](https://www.codacy.com/gh/rx-ts/lib-boilerplate)
[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Frx-ts%2Flib-boilerplate%2Fmain%2Fpackage.json)](https://github.com/plantain-00/type-coverage)
[![npm](https://img.shields.io/npm/v/lib-boilerplate.svg)](https://www.npmjs.com/package/lib-boilerplate)
[![GitHub Release](https://img.shields.io/github/release/rx-ts/lib-boilerplate)](https://github.com/rx-ts/lib-boilerplate/releases)
[![GitHub Actions](https://github.com/rx-ts/typemod/workflows/CI/badge.svg)](https://github.com/rx-ts/typemod/actions/workflows/ci.yml)
[![Codecov](https://img.shields.io/codecov/c/github/rx-ts/typemod.svg)](https://codecov.io/gh/rx-ts/typemod)
[![Codacy Grade](https://img.shields.io/codacy/grade/27907e42d2e743c6a45317166d534110)](https://www.codacy.com/gh/rx-ts/typemod)
[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Frx-ts%2Ftypemod%2Fmain%2Fpackage.json)](https://github.com/plantain-00/type-coverage)
[![npm](https://img.shields.io/npm/v/typemod.svg)](https://www.npmjs.com/package/typemod)
[![GitHub Release](https://img.shields.io/github/release/rx-ts/typemod)](https://github.com/rx-ts/typemod/releases)

[![David Peer](https://img.shields.io/david/peer/rx-ts/lib-boilerplate.svg)](https://david-dm.org/rx-ts/lib-boilerplate?type=peer)
[![David](https://img.shields.io/david/rx-ts/lib-boilerplate.svg)](https://david-dm.org/rx-ts/lib-boilerplate)
[![David Dev](https://img.shields.io/david/dev/rx-ts/lib-boilerplate.svg)](https://david-dm.org/rx-ts/lib-boilerplate?type=dev)
[![David Peer](https://img.shields.io/david/peer/rx-ts/typemod.svg)](https://david-dm.org/rx-ts/typemod?type=peer)
[![David](https://img.shields.io/david/rx-ts/typemod.svg)](https://david-dm.org/rx-ts/typemod)
[![David Dev](https://img.shields.io/david/dev/rx-ts/typemod.svg)](https://david-dm.org/rx-ts/typemod?type=dev)

[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
Expand All @@ -22,29 +22,35 @@ A simple library boilerplate.
## TOC <!-- omit in toc -->

- [Usage](#usage)
- [Peer](#peer)
- [Install](#install)
- [API](#api)
- [CLI](#cli)
- [Changelog](#changelog)
- [License](#license)

## Usage

### Peer

You need to install [`jscodeshift`](https://github.com/facebook/jscodeshift) first.

### Install

```sh
# yarn
yarn add pkg

# npm
npm i pkg
```
npm i -D typemod

### API
# pnpm
pnpm add -D typemod

```js
import echo from 'pkg'
# yarn
yarn add -D typemod
```

echo()
### CLI

```sh
jscodeshift -t node_modules/typemod/lib/override.js src
```

## Changelog
Expand Down

0 comments on commit 2ea1301

Please sign in to comment.