Skip to content

Commit 6d1b43e

Browse files
authored
Merge pull request #36 from armano2/fix/update-package
2 parents 0a0b6da + 043cf08 commit 6d1b43e

17 files changed

+1121
-694
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
![GitHub package.json version (master)](https://img.shields.io/github/package-json/v/nebrelbug/npm-to-yarn/master?label=current%20version)
1010
[![Travis](https://img.shields.io/travis/com/nebrelbug/npm-to-yarn/master.svg)](https://travis-ci.com/nebrelbug/npm-to-yarn)
11-
[![All Contributors][logo]](#contributors-)
11+
[![All Contributors][logo]](#contributors)
1212
[![Coveralls](https://img.shields.io/coveralls/nebrelbug/npm-to-yarn.svg)](https://coveralls.io/github/nebrelbug/npm-to-yarn)
1313

1414
[![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')
4040

4141
### API
4242

43-
`convert(command: string, to: 'yarn' | 'npm') -> string`
43+
```ts
44+
/**
45+
* Converts between npm and yarn command
46+
*/
47+
export default function convert(str: string, to: 'npm' | 'yarn'): string;
48+
```
4449

4550
## ✔️ Tests
4651

@@ -53,6 +58,7 @@ To be added
5358
## Projects using `npm-to-yarn`
5459

5560
- [Dynamoose](https://dynamoosejs.com)
61+
- [Docusaurus](https://docusaurus.io)
5662

5763
## Contributors
5864

0 commit comments

Comments
 (0)