From 9171a85d6555cdc4534c08d7a0f35ec842d6637e Mon Sep 17 00:00:00 2001 From: Armano Date: Sun, 12 Feb 2023 10:18:49 +0100 Subject: [PATCH] docs: add missing readme change --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f2a471f..794486b 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ![GitHub package.json version (master)](https://img.shields.io/github/package-json/v/nebrelbug/npm-to-yarn/master?label=current%20version) [![Travis](https://img.shields.io/travis/com/nebrelbug/npm-to-yarn/master.svg)](https://travis-ci.com/nebrelbug/npm-to-yarn) -[![All Contributors][logo]](#contributors-) +[![All Contributors][logo]](#contributors) [![Coveralls](https://img.shields.io/coveralls/nebrelbug/npm-to-yarn.svg)](https://coveralls.io/github/nebrelbug/npm-to-yarn) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) @@ -40,7 +40,12 @@ convert('npm install squirrelly', 'yarn') ### API -`convert(command: string, to: 'yarn' | 'npm') -> string` +```ts +/** + * Converts between npm and yarn command + */ +export default function convert(str: string, to: 'npm' | 'yarn'): string; +``` ## ✔️ Tests @@ -53,6 +58,7 @@ To be added ## Projects using `npm-to-yarn` - [Dynamoose](https://dynamoosejs.com) +- [Docusaurus](https://docusaurus.io) ## Contributors